diff options
Diffstat (limited to '')
376 files changed, 30969 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..0e76f09e6 --- /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 LibreOffice Basic library of macros for (business or personal) application developers and advanced users. It is one of the libraries stored in "LibreOffice 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 LibreOffice <emph>Base</emph> application, but also from <emph>any</emph> LibreOffice 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/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/sample_code.xhp b/helpcontent2/source/text/sbasic/guide/sample_code.xhp new file mode 100644 index 000000000..7ef8b6a45 --- /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 %PRODUCTNAME 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..867cd1ad4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/main0000.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="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="pythonalt"> + <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>%PRODUCTNAME 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/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..60d31312a --- /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 fourth across calls, providing they represent primitives 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 nested Basic engine may be absent. Avoid Python to %PRODUCTNAME Basic calls in such context. 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" id="N0369"><literal>results = script.invoke((prompt,buttons,title), (), ())</literal></paragraph> + <paragraph role="paragraph" id="N0370"><literal>script.invoke((message,), tuple, ())</literal></paragraph> + <paragraph role="paragraph" id="N0371"><literal>script.invoke((args), (), results)</literal></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..7f728b495 --- /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 (%PRODUCTNAME 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 %PRODUCTNAME 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..34a3f5a5b --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_document_events.xhp @@ -0,0 +1,276 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.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">Python : 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>Tools;Strings</bookmark_value> + <bookmark_value>API;GlobalScope.BasicLibraries</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;frame.Desktop: Monitoring Document Event</bookmark_value> + <bookmark_value>API;frame.GlobalEventBroadcaster: Monitoring Document Event</bookmark_value> + <bookmark_value>API;lang.EventObject: 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> + <section id="pythonmonitor1"> + <h1 id="N0527"><variable id="pythonmonitor"><link href="text/sbasic/python/python_document_events.xhp" name="Monitoring Document Events">Monitoring Document Events</link></variable></h1> + </section> + <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> + <h2 id="N0529">Listening to 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 <literal>Open Document</literal> event, suffices to initiate and terminate document event monitoring. <menuitem>Tools – Customise...</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> + <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 <literal>Open document</literal> and <literal>Document closed</literal>.</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" xml-lang="en-US" 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" localize="false" 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" localize="false" 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"><literal>Start application</literal> and <literal>Close application</literal> 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 <literal>Open document</literal> and <literal>Document closed</literal> 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> + <paragraph role="paragraph" id="N0650">The <literal>Onload</literal> script is assigned to <literal>Open document</literal> event using <menuitem>Tools – Customise...</menuitem> menu <menuitem>Events</menuitem> tab. Events monitoring starts from the moment a <literal>ConsoleLogger</literal> object is instantiated and ultimately stops when Basic engine releases it. <literal>OnLoad</literal> event loads necessary Basic libraries, while caught events are reported using <literal>Access2Base.Trace</literal> module.</paragraph> + <bascode> + <paragraph role="bascode" xml-lang="en-US" id="N0651">REM controller.Events module</paragraph> + <paragraph role="bascode" localize="false" id="N0652">Option Explicit</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0653">Private _obj As Object ' controller.ConsoleLogger instance</paragraph> + <paragraph role="bascode" localize="false" id="N0654"> </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.Start(evt)</paragraph> + <paragraph role="bascode" localize="false" id="N0657">End Sub ' controller.OnLoad</paragraph> + <paragraph role="bascode" localize="false" id="N0658">' ----</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0659">REM controller.ConsoleLogger class module</paragraph> + <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 « Open Document » event</paragraph> + <paragraph role="bascode" localize="false" id="N0665">Private Const UI_PROMPT = True</paragraph> + <paragraph role="bascode" localize="false" 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="N0668">' CONSTRUCTOR/DESTRUCTOR</paragraph> + <paragraph role="bascode" localize="false" id="N0669">Private Sub Class_Initialize()</paragraph> + <paragraph role="bascode" localize="false" id="N0670">End Sub ' controller.ConsoleLogger.Initialize</paragraph> + <paragraph role="bascode" localize="false" id="N0671">Private Sub Class_Terminate()</paragraph> + <paragraph role="bascode" localize="false" id="N0672">End Sub ' controller.ConsoleLogger.Terminate</paragraph> + <paragraph role="bascode" localize="false" id="N0673"> </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" localize="false" id="N0676"> </paragraph> + <paragraph role="bascode" localize="false" 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">Private Sub _documentEventOccured(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" : _Stop(evt)</paragraph> + <paragraph role="bascode" localize="false" id="N0694"> End Select</paragraph> + <paragraph role="bascode" localize="false" id="N0695">End Sub ' controller.ConsoleLogger._documentEventOccured</paragraph> + <paragraph role="bascode" localize="false" id="N0696"> </paragraph> + <paragraph role="bascode" localize="false" id="N0697">Private Sub _disposing(evt As com.sun.star.lang.EventObject)</paragraph> + <paragraph role="bascode" localize="false" id="N0698">End Sub ' controller.ConsoleLogger.disposing</paragraph> + <paragraph role="bascode" localize="false" id="N0699"> </paragraph> + <paragraph role="bascode" localize="false" id="N0700">Public Sub Start(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="N0705"> Access2Base.Trace.TraceLog("INFO", _</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0706"> IIf(IsMissing(evt),"",evt.EventName & "-") & "Document events are being logged", _</paragraph> + <paragraph role="bascode" localize="false" id="N0707"> UI_PROMPT)</paragraph> + <paragraph role="bascode" localize="false" id="N0708"> </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.Start</paragraph> + <paragraph role="bascode" localize="false" id="N0712"> </paragraph> + <paragraph role="bascode" localize="false" id="N0713">Private Sub _Stop(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"> Access2Base.Trace.TraceLog("INFO", _</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0717"> IIf(IsMissing(evt),"",evt.EventName & "-") & "Document events have been logged", _</paragraph> + <paragraph role="bascode" localize="false" id="N0718"> UI_PROMPT)</paragraph> + <paragraph role="bascode" localize="false" id="N0719"> Access2Base.Trace.TraceConsole() ' Captured events dialog</paragraph> + <paragraph role="bascode" localize="false" id="N0720">End Sub ' controller.ConsoleLogger._Stop</paragraph> + <paragraph role="bascode" localize="false" id="N0721"> </paragraph> + <paragraph role="bascode" localize="false" 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> + <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> 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..c6cdd39f5 --- /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 behaviour. 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..4ec027b43 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_locations.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="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_id771543358231022" role="paragraph" xml-lang="en-US">The Python script files are stored in the filesystem, in folders controlled by %PRODUCTNAME. The macros can be started at installation, user or file level.</paragraph> + </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">%PRODUCTNAME Macros container</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">Like BASIC macros, Python macros can be organized in libraries, modules and macros.</paragraph> + <h3 id="hd_id21544209865082">Creating a Python Library</h3> + <paragraph role="paragraph" id="par_id191544209928221">Libraries are folders in the container tree. To create a library, add a folder in the target container. The library name is the folder name.</paragraph> + <h3 id="hd_id31544209872869">Creating a Python Module.</h3> + <paragraph role="paragraph" id="par_id161544209936743">A module is a python file in the library or the container. Create a module adding a file in the container.</paragraph> + <h3 id="hd_id151544209895574">Python macros</h3> + <paragraph role="paragraph" id="par_id61544209944591">A macro is a python object in the module.</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..5efa8df15 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_programming.xhp @@ -0,0 +1,319 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.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>uno.py</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..0b724b88d --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_shell.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="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"> + <paragraph role="heading" level="1" id="N0118"><variable id="pythonshell1"><link href="text/sbasic/python/python_shell.xhp" name="python shell">Running Python Interactive Console</link></variable></paragraph> + </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> + <paragraph role="heading" level="2" id="N0121">Using a Basic macro:</paragraph> + <bascode> + <paragraph role="bascode" id="N0122" localize="false">Sub interpreter_console</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="N0125" localize="false"> Shell( install_path + GetPathSeparator() + "python" )</paragraph> + <paragraph role="bascode" id="N0126" localize="false">End Sub</paragraph> + </bascode> + <paragraph role="heading" level="2" id="N0127">Using a Python macro:</paragraph> + <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> + <paragraph role="heading" level="2" id="N0141">Usage:</paragraph> + <paragraph role="paragraph" id="N0142"> + <image src="media/helpimg/python/python_shell.png" id="N0143"><alt id="N0144">Python Interactive Console</alt></image> + </paragraph> + <section id="relatedtopics"> + <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/shared/00000002.xhp b/helpcontent2/source/text/sbasic/shared/00000002.xhp new file mode 100644 index 000000000..bfdfc2aaf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/00000002.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="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> +<paragraph role="heading" id="hd_id3145068" xml-lang="en-US" level="1"><link href="text/sbasic/shared/00000002.xhp" name="$[officename] Basic Glossary">$[officename] Basic Glossary</link></paragraph> +<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"> +<section id="dezimal"> +<paragraph role="heading" id="hd_id3155133" xml-lang="en-US" level="2">Decimal Point</paragraph> +<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"> +<paragraph role="heading" id="hd_id3155854" xml-lang="en-US" level="2">Colors</paragraph> +<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"> +<paragraph role="heading" id="hd_id3146119" xml-lang="en-US" level="2">Measurement Units</paragraph> +<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> +<paragraph role="heading" id="hd_id3145801" xml-lang="en-US" level="2">Twips</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153159" xml-lang="en-US" level="2">URL Notation</paragraph> +<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..efa7db761 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/00000003.xhp @@ -0,0 +1,347 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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="farbcodes"> +<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="paragraph" xml-lang="en-US"><emph>Color Value</emph></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154319" role="paragraph" xml-lang="en-US"><emph>Color Name</emph></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3151112" role="paragraph" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155854" role="paragraph" xml-lang="en-US">Black</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154942" role="paragraph" xml-lang="en-US">128</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154731" role="paragraph" xml-lang="en-US">Blue</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3145645" role="paragraph" xml-lang="en-US">32768</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149400" role="paragraph" xml-lang="en-US">Green</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150753" role="paragraph" xml-lang="en-US">32896</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153765" role="paragraph" xml-lang="en-US">Cyan</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154756" role="paragraph" xml-lang="en-US">8388608</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159266" role="paragraph" xml-lang="en-US">Red</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3163807" role="paragraph" xml-lang="en-US">8388736</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145150" role="paragraph" xml-lang="en-US">Magenta</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3147002" role="paragraph" xml-lang="en-US">8421376</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3152778" role="paragraph" xml-lang="en-US">Yellow</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150088" role="paragraph" xml-lang="en-US">8421504</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159239" role="paragraph" xml-lang="en-US">White</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150206" role="paragraph" xml-lang="en-US">12632256</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149817" role="paragraph" xml-lang="en-US">Gray</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150363" role="paragraph" xml-lang="en-US">255</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154576" role="paragraph" xml-lang="en-US">Light blue</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150367" role="paragraph" xml-lang="en-US">65280</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150202" role="paragraph" xml-lang="en-US">Light green</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154487" role="paragraph" xml-lang="en-US">65535</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151332" role="paragraph" xml-lang="en-US">Light cyan</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3148702" role="paragraph" xml-lang="en-US">16711680</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153067" role="paragraph" xml-lang="en-US">Light red</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153912" role="paragraph" xml-lang="en-US">16711935</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159097" role="paragraph" xml-lang="en-US">Light magenta</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3155266" role="paragraph" xml-lang="en-US">16776960</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3157978" role="paragraph" xml-lang="en-US">Light yellow</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153286" role="paragraph" xml-lang="en-US">16777215</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151302" role="paragraph" xml-lang="en-US">Transparent white</paragraph> + </tablecell> + </tablerow> +</table> +</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">%PRODUCTNAME 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. Place the following statement before the first macro in your module:</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> + +<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..1e436a2b1 --- /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="programmieren"> + <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#daten"/> + <embed href="text/sbasic/shared/01030000.xhp#ide"/> + <embed href="text/sbasic/shared/01040000.xhp#weitere"/> + </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..24b1d8165 --- /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="daten"> + <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#objekte"/> + <embed href="text/sbasic/shared/01020300.xhp#prozedur"/> + <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..8b777f7ba --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020100.xhp @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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;integer</bookmark_value> + <bookmark_value>literals;hexadecimal</bookmark_value> + <bookmark_value>literals;integer</bookmark_value> + <bookmark_value>literals;octal</bookmark_value> + <bookmark_value>literals;&h notation</bookmark_value> + <bookmark_value>literals;&o notation</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> + + +<paragraph id="hd_id3149346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/01020100.xhp" name="Using Variables">Using Variables</link></paragraph> +<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US">The following describes the basic use of variables in $[officename] Basic.</paragraph> +</section> + +<paragraph id="hd_id3153361" role="heading" level="2" xml-lang="en-US">Naming Conventions for Variable Identifiers</paragraph> +<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> + +<paragraph id="hd_id3146317" role="heading" level="2" xml-lang="en-US">Declaring Variables</paragraph> +<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> + +<paragraph id="par_id3144770" role="warning" xml-lang="en-US">Once you have declared a variable as a certain type, you cannot declare the variable under the same name again as a different type!</paragraph> + +<paragraph id="hd_id3149331" role="heading" level="3" xml-lang="en-US">Forcing Variable Declarations</paragraph> +<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> + +<paragraph id="hd_id3154614" role="heading" level="2" xml-lang="en-US">Variable Types</paragraph> +<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> + +<paragraph id="hd_id3153805" role="heading" level="3" xml-lang="en-US">Integer Variables</paragraph> +<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> + +<paragraph id="hd_id3147546" role="heading" level="3" xml-lang="en-US">Long Integer Variables</paragraph> +<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> + +<paragraph id="hd_id7596972" role="heading" level="3" xml-lang="en-US">Decimal Variables<comment>see i64349</comment></paragraph> +<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> + +<paragraph id="hd_id3147500" role="heading" level="3" xml-lang="en-US">Single Variables</paragraph> +<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> + +<paragraph id="hd_id3155753" role="heading" level="3" xml-lang="en-US">Double Variables</paragraph> +<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> + +<paragraph id="hd_id3155747" role="heading" level="3" xml-lang="en-US">Currency Variables</paragraph> +<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> + +<paragraph id="hd_id3148742" role="heading" level="3" xml-lang="en-US">String Variables</paragraph> +<paragraph id="par_id3151393" role="paragraph" xml-lang="en-US">String variables can hold character strings with up to 65,535 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 64 Kbytes. The memory required for storing string variables depends on the number of characters in the variable. The type-declaration character is "$".</paragraph> +<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> + +<paragraph id="hd_id3150534" role="heading" level="3" xml-lang="en-US">Boolean Variables</paragraph> +<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> + +<paragraph id="hd_id3149722" role="heading" level="3" xml-lang="en-US">Date Variables</paragraph> +<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> + +<paragraph id="hd_id3148732" role="heading" level="2" xml-lang="en-US">Initial Variable Values</paragraph> +<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> + +<paragraph id="hd_id3153936" role="heading" level="2" xml-lang="en-US">Arrays</paragraph> +<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> + +<paragraph id="hd_id3154507" role="heading" level="2" xml-lang="en-US">Constants</paragraph> +<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> +</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..aa69b267c --- /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="objekte"> +<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..6780cbda9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020300.xhp @@ -0,0 +1,164 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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="prozedur"> +<h1 id="hd_id3149456"><link href="text/sbasic/shared/01020300.xhp">Using Procedures, Functions and Properties</link></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">SubName(Value1, 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, Parameter2,...)</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id981584288549909">Properties combine the syntax of procedures and functions. A property 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>Library.Module.Macro()</literal> <br/> For example, to call the Autotext macro from the Gimmicks library, use the following command:<br/> <item type="literal">Gimmicks.AutoText.Main()</item> </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_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> diff --git a/helpcontent2/source/text/sbasic/shared/01020500.xhp b/helpcontent2/source/text/sbasic/shared/01020500.xhp new file mode 100644 index 000000000..297dfaab7 --- /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..bfc4c77c0 --- /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#ueberblick"/> +<embed href="text/sbasic/shared/01030400.xhp#anlegenverwalten"/> +<embed href="text/sbasic/shared/01030200.xhp#basiceditor"/> +<embed href="text/sbasic/shared/01030300.xhp#basicfehler"/> +<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..102ba799f --- /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="ueberblick"> +<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..3045d3a85 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030200.xhp @@ -0,0 +1,86 @@ +<?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> +<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><paragraph role="heading" id="hd_id3147264" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01030200.xhp" name="The Basic Editor">The Basic Editor</link></paragraph> +</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> +<paragraph role="tip" id="par_id59816" xml-lang="en-US">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.</paragraph> +<paragraph role="heading" id="hd_id3125863" xml-lang="en-US" level="2">Navigating in a Project</paragraph> +<paragraph role="heading" id="hd_id3145785" xml-lang="en-US" level="3">The Library List</paragraph> +<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> +<paragraph role="heading" id="hd_id3153190" xml-lang="en-US" level="3">The Object Catalog</paragraph> +<embed href="text/sbasic/shared/01020200.xhp#object_catalog"/> +<paragraph role="heading" id="hd_id3148647" xml-lang="en-US" level="2">Saving and Loading Basic Source Code</paragraph> +<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> +<paragraph role="warning" id="par_id3149959" xml-lang="en-US">You cannot save Basic dialogs to a text file.</paragraph> +<paragraph role="heading" id="hd_id3149403" xml-lang="en-US" level="3">Saving Source Code to a Text File</paragraph> +<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> +<paragraph role="heading" id="hd_id3159264" xml-lang="en-US" level="3">Loading Source Code From a Text File</paragraph> +<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..71eabb848 --- /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="basicfehler"> +<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..73f4ccdaa --- /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="anlegenverwalten"> +<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>%PRODUCTNAME 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>%PRODUCTNAME 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 %PRODUCTNAME 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 %PRODUCTNAME 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..8d9e2bb8b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01040000.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="textsbasicshared01040000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Event-Driven Macros</title> + <filename>/text/sbasic/shared/01040000.xhp</filename> + </topic> + </meta> + <body> + <section id="weitere"> +<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>events; assigning macros</bookmark_value> +</bookmark> +<paragraph xml-lang="en-US" id="hd_id3147348" role="heading" level="1"><link href="text/sbasic/shared/01040000.xhp" name="Event-Driven Macros">Event-Driven Macros</link></paragraph> + <paragraph xml-lang="en-US" id="par_id3146120" role="paragraph">This section describes how to assign Basic programs to program events.</paragraph> + </section> + <paragraph xml-lang="en-US" 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 program events and at what point an assigned macro is executed.</paragraph> + <table id="tbl_id3148646"> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3148455" role="tablehead">Event</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145799" role="tablehead">An assigned macro is executed...</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3149379" role="tablecontent">Program Start</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3150715" role="tablecontent">... after a $[officename] application is started.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3146914" role="tablecontent">Program End</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3153765" role="tablecontent">...before a $[officename] application is terminated.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145150" role="tablecontent">Create Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145790" role="tablecontent">Open Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3154572" role="tablecontent">...after a document is opened with <emph>File - Open</emph> or with the <emph>Open</emph> icon.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3153266" role="tablecontent">Save Document As</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3158215" role="tablecontent">Document has been saved as</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3150519" role="tablecontent">Save Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3149404" role="tablecontent">Document has been saved</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3159171" role="tablecontent">Document is closing<comment>i104852</comment></paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3146868" role="tablecontent">...before a document is closed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3159097" role="tablecontent">Document closed</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" 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> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3144772" role="tablecontent">Activate Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3149442" role="tablecontent">...after a document is brought to the foreground.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3150888" role="tablecontent">Deactivate Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3154060" role="tablecontent">...after another document is brought to the foreground.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3152384" role="tablecontent">Print Document</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3152873" role="tablecontent">...after the <emph>Print</emph> dialog is closed, but before the actual print process begins.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3159227" role="tablecontent">JavaScript run-time error</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145362" role="tablecontent">...when a JavaScript run-time error occurs.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3154767" role="tablecontent">Print Mail Merge</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3153555" role="tablecontent">...after the <emph>Print</emph> dialog is closed, but before the actual print process begins. This event occurs for each copy printed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3156366" role="tablecontent">Change of the page count</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3154627" role="tablecontent">...when the page count changes.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3154737" role="tablecontent">Message received</paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3150952" role="tablecontent">...if a message was received.</paragraph> + </tablecell> + </tablerow> + </table> + + <paragraph xml-lang="en-US" id="hd_id3153299" role="heading" level="2">Assigning a Macro to an Event</paragraph> + <list type="ordered"> + <listitem> + <paragraph xml-lang="en-US" id="par_id3147244" role="listitem">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" 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 xml-lang="en-US" id="par_id3150431" role="listitem">Select the event from the <emph>Event</emph> list.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" id="par_id3148742" role="listitem">Click <emph>Macro</emph> and select the macro to be assigned to the selected event.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" id="par_id3146321" role="listitem">Click <emph>OK</emph> to assign the macro.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" id="par_id3147414" role="listitem">Click <emph>OK</emph> to close the dialog.</paragraph> + </listitem> + </list> + <paragraph xml-lang="en-US" id="hd_id3154581" role="heading" level="2">Removing the Assignment of a Macro to an Event</paragraph> + <list type="ordered"> + <listitem> + <paragraph xml-lang="en-US" id="par_id3146883" role="listitem">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" 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 xml-lang="en-US" 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 xml-lang="en-US" id="par_id3149143" role="listitem">Click <emph>Remove</emph>.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" id="par_id3149351" role="listitem">Click <emph>OK</emph> to close the dialog.</paragraph> + </listitem> + </list> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/01050000.xhp b/helpcontent2/source/text/sbasic/shared/01050000.xhp new file mode 100644 index 000000000..459be373a --- /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#makro"/> +<embed href="text/sbasic/shared/01050100.xhp#beobachter"/> +<embed href="text/sbasic/shared/01050200.xhp#kommando"/> +<embed href="text/sbasic/shared/01050300.xhp#haltepunkte"/> +<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..acbd67cb9 --- /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="beobachter"> +<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..be2374454 --- /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="kommando"> +<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..cad3ad6ff --- /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="haltepunkte"> +<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..05153753d --- /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#allgemein"/> +<embed href="text/sbasic/shared/01170103.xhp#ereignisse"/> +</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..80fb865c5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01170101.xhp @@ -0,0 +1,444 @@ +<?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="allgemein"> +<paragraph role="heading" id="hd_id3147436" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01170101.xhp" name="General">General</link></paragraph> +<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"><section id="Section64"> +<!-- removed HID HID_PROP_IMAGE_ALIGN --><paragraph role="heading" id="hd_id3148647" xml-lang="en-US" level="2">Alignment</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153189" xml-lang="en-US" level="2">AutoFill</paragraph> +<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"><paragraph role="heading" id="hd_id3155307" xml-lang="en-US" level="2">Background color</paragraph> +<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"> +<paragraph role="heading" id="hd_id3151076" xml-lang="en-US" level="2">Large change</paragraph> +<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"><paragraph role="heading" id="hd_id3153876" xml-lang="en-US" level="2">Border</paragraph> +<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"> +<paragraph role="heading" id="hd_id3150749" xml-lang="en-US" level="2">Button type</paragraph> +<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"><paragraph role="heading" id="hd_id3149019" xml-lang="en-US" level="2">Character set</paragraph> +<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"> +<paragraph role="heading" id="hd_id3147341" xml-lang="en-US" level="2">Currency symbol</paragraph> +<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"/><paragraph role="heading" id="hd_id7936643" xml-lang="en-US" level="2">Date</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153965" xml-lang="en-US" level="2">Date format</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154663" xml-lang="en-US" level="2">Date max.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3152778" xml-lang="en-US" level="2">Date min.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154573" xml-lang="en-US" level="2">Decimal accuracy</paragraph> +<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"> +<paragraph role="heading" id="hd_id3159091" xml-lang="en-US" level="2">Default button</paragraph> +<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"/><paragraph role="heading" id="par_idN108BA" xml-lang="en-US" level="2">Delay</paragraph> +<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"><paragraph role="heading" id="hd_id3151278" xml-lang="en-US" level="2">Dropdown</paragraph> +<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"> +<paragraph role="heading" id="hd_id3151216" xml-lang="en-US" level="2">Enabled</paragraph> +<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"> +<paragraph role="heading" id="hd_id3155379" xml-lang="en-US" level="2">Edit mask</paragraph> +<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 colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3155809" xml-lang="en-US"> Character </paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3148702" xml-lang="en-US">Meaning</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3156199" xml-lang="en-US">L</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3156016" xml-lang="en-US">a</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3148607" xml-lang="en-US">A</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3149126" xml-lang="en-US">c</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3152870" xml-lang="en-US">C</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3159230" xml-lang="en-US">N</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3154650" xml-lang="en-US">Only the characters 0-9 can be entered.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3149383" xml-lang="en-US">x</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3153489" xml-lang="en-US">All printable characters can be entered.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3146967" xml-lang="en-US">X</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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"/><paragraph role="heading" id="hd_id2128971" xml-lang="en-US" level="2">Editable</paragraph> +<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"><paragraph role="heading" id="hd_id3149317" xml-lang="en-US" level="2">Graphics</paragraph> +<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"/><paragraph role="heading" id="hd_id3154627" xml-lang="en-US" level="2">Height</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153072" xml-lang="en-US" level="2">Help text</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154400" xml-lang="en-US" level="2">Help URL</paragraph> +<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"> +<paragraph role="heading" id="hd_id3159260" xml-lang="en-US" level="2">Incr./decrement value</paragraph> +<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"/><paragraph role="heading" id="hd_id539262" xml-lang="en-US" level="2">Invokes stop mode editing</paragraph> +<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"><paragraph role="heading" id="hd_id3150536" xml-lang="en-US" level="2">Label</paragraph> +<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"> +<paragraph role="heading" id="hd_id3150457" xml-lang="en-US" level="2">Line Count</paragraph> +<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"> +<paragraph role="heading" id="hd_id7468489" xml-lang="en-US" level="2">Scrollbar</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153121" xml-lang="en-US" level="2">Small change</paragraph> +<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"><paragraph role="heading" id="hd_id3145221" xml-lang="en-US" level="2">List entries</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149723" xml-lang="en-US" level="2">Literal mask</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149015" xml-lang="en-US" level="2">Manual line break</paragraph> +<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"> +<paragraph role="heading" id="hd_id3150463" xml-lang="en-US" level="2">Max. text length</paragraph> +<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"><paragraph role="heading" id="hd_id3154675" xml-lang="en-US" level="2">Multiline Input</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154848" xml-lang="en-US" level="2">Multiselection</paragraph> +<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"><paragraph role="heading" id="hd_id3148887" xml-lang="en-US" level="2">Name</paragraph> +<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"><paragraph role="heading" id="hd_id3148739" xml-lang="en-US" level="2">Order</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149511" xml-lang="en-US" level="2">Orientation</paragraph> +<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"/><paragraph role="heading" id="hd_id3154374" xml-lang="en-US" level="2">Page (step)</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154558" xml-lang="en-US" level="2">Password characters</paragraph> +<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"/><paragraph role="heading" id="hd_id3148750" xml-lang="en-US" level="2">PositionX</paragraph><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"/><paragraph role="heading" id="hd_id3152767" xml-lang="en-US" level="2">PositionY</paragraph> +<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"> +<paragraph role="heading" id="hd_id3159213" xml-lang="en-US" level="2">Prefix symbol</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149728" xml-lang="en-US" level="2">Print</paragraph> +<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"> +<paragraph role="heading" id="hd_id3154671" xml-lang="en-US" level="2">Progress value</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153112" xml-lang="en-US" level="2">Progress value max.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153569" xml-lang="en-US" level="2">Progress value min.</paragraph> +<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"><paragraph role="heading" id="hd_id3150134" xml-lang="en-US" level="2">Read-only</paragraph> +<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"/><paragraph role="heading" id="par_idN11112" xml-lang="en-US" level="2">Repeat<comment>UFI: see spec spinbutton_form_control.sxw</comment></paragraph> +<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"/><paragraph role="heading" id="hd_id9579149" xml-lang="en-US" level="2">Root displayed<comment>see http://specs.openoffice.org/appwide/dialog_ide/New_Tree_Control_in_IDE.odt</comment></paragraph> +<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"> +<paragraph role="heading" id="hd_id7534409" xml-lang="en-US" level="2">Row height</paragraph> +<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"> +<paragraph role="heading" id="hd_id3148761" xml-lang="en-US" level="2">Scale</paragraph> +<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"/><paragraph role="heading" id="hd_id7597277" xml-lang="en-US" level="2">Scrollbar</paragraph> +<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"/><paragraph role="heading" id="hd_id3147370" xml-lang="en-US" level="2">Scroll value</paragraph> +<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"/><paragraph role="heading" id="hd_id3155440" xml-lang="en-US" level="2">Scroll value max.</paragraph> +<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"/><paragraph role="heading" id="par_idN111E4" xml-lang="en-US" level="2">Scroll value min.</paragraph> +<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"/><paragraph role="heading" id="hd_id543534" xml-lang="en-US" level="2">Show handles</paragraph> +<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"/><paragraph role="heading" id="hd_id4062013" xml-lang="en-US" level="2">Show root handles</paragraph> +<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"> +<paragraph role="heading" id="par_idN10EC2" xml-lang="en-US" level="2">Selection<comment>UFI: udk.features "New property and help ID for property browser in Basic IDE"</comment></paragraph> +<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"/><paragraph role="heading" id="hd_id5026093" xml-lang="en-US" level="2">Selection type<comment>see http://specs.openoffice.org/appwide/dialog_ide/New_Tree_Control_in_IDE.odt</comment></paragraph> +<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"><paragraph role="heading" id="hd_id3154193" xml-lang="en-US" level="2">Spin Button</paragraph> +<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"> +<paragraph role="heading" id="hd_id3156267" xml-lang="en-US" level="2">State</paragraph> +<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"> +<paragraph role="heading" id="hd_id3148396" xml-lang="en-US" level="2">Strict format</paragraph> +<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"><paragraph role="heading" id="hd_id3149538" xml-lang="en-US" level="2">Tabstop</paragraph> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3148776" xml-lang="en-US">Default</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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 colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3154632" xml-lang="en-US">No</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3150475" xml-lang="en-US">When using the tab key focusing skips the control.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3150690" xml-lang="en-US">Yes</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<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"> +<paragraph role="heading" id="hd_id3145152" xml-lang="en-US" level="2">Thousands Separator</paragraph> +<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"> +<paragraph role="heading" id="hd_id3152816" xml-lang="en-US" level="2">Time Format</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153920" xml-lang="en-US" level="2">Time max.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3163818" xml-lang="en-US" level="2">Time min.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3148638" xml-lang="en-US" level="2">Title</paragraph> +<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"> +<paragraph role="heading" id="hd_id3152594" xml-lang="en-US" level="2">Tristate</paragraph> +<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"> +<paragraph role="heading" id="hd_id3150614" xml-lang="en-US" level="2">Value</paragraph> +<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"> +<paragraph role="heading" id="hd_id3152480" xml-lang="en-US" level="2">Value max.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149276" xml-lang="en-US" level="2">Value min.</paragraph> +<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"> +<paragraph role="heading" id="hd_id3149712" xml-lang="en-US" level="2">Visible size</paragraph> +<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"><paragraph role="heading" id="hd_id3152472" xml-lang="en-US" level="2">Width</paragraph> +<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..f08026f8b --- /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="ereignisse"> +<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..eb78c2348 --- /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="uebersetzen"> +<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="syuebersetzen"> + <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..6bafb5cde --- /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="ausfuehren"> +<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="syausfuehren"> +<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..52c2522d6 --- /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="anhalten"> +<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="syanhalten"> +<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..80d38ae25 --- /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="einzelschritt"> +<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="syeinzelschritt"> +<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..6543c8e9b --- /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="prozedurschritt"> +<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="syprozedurschritt"> +<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..ffee38d3b --- /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="haltepunkt"> +<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="syhaltepunkt"> +<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..dcb2355b6 --- /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="beobachter"> +<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="sybeobachter"> +<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..3fdc5cc77 --- /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="okatalog"> +<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="syobjektkatalog"> +<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..6fca55681 --- /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="makros"> +<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="symakros"> + <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..2b9009a4b --- /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="klammer"> +<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="syklammer"> + <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..156aae60d --- /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="laden"> +<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="syladen"> +<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..b10f1bc79 --- /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="speichern"> +<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="syspeichern"> +<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..3ec6a2168 --- /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="ruecksprung"> +<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="syruecksprung"> + <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..0f6286edc --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/20000000.xhp @@ -0,0 +1,506 @@ +<?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="kontrollfelder"> +<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"/> +<paragraph role="heading" id="hd_id3150402" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/20000000.xhp" name="Insert Controls">Insert Controls</link></paragraph> +<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="sykontrollfelder"> +<table id="tbl_id3153539"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3147226" xml-lang="en-US"> +<image id="img_id3147571" src="cmd/sc_choosecontrols.png" width="0.222inch" height="0.222inch"><alt id="alt_id3147571" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2">Button</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3157909" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3148550" xml-lang="en-US" level="2">Image Control</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3144760" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3150447" xml-lang="en-US" level="2">Check Box</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3150439" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3150486" xml-lang="en-US" level="2">Option Button</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3146921" xml-lang="en-US">Icon</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 indices. They are commonly encircled by a group box. If you have two groups of option buttons, you must insert a tab index between the tab indices of the two groups on the group frame.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="label"> +<paragraph role="heading" id="hd_id3154729" xml-lang="en-US" level="2">Label Field</paragraph> +<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="0.0874inch" height="0.0874inch"><alt id="alt_id3153415" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3149123" xml-lang="en-US" level="2">Text Box</paragraph> +<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="0.0874inch" height="0.0874inch"><alt id="alt_id3148996" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3154253" xml-lang="en-US" level="2">List Box</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3163808" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3150644" xml-lang="en-US" level="2">Combo Box</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3153200" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3154585" xml-lang="en-US" level="2">Horizontal Scrollbar</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3149530" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3154119" xml-lang="en-US" level="2">Vertical Scrollbar</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3150203" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3150313" xml-lang="en-US" level="2">Group Box</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3151335" xml-lang="en-US">Icon</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> +<paragraph role="note" id="par_id3148820" xml-lang="en-US">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.</paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:ProgressBar" id="bm_id9634998" localize="false"/> +<section id="progressbar"> +<paragraph role="heading" id="hd_id3149330" xml-lang="en-US" level="2">Progress Bar</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3150318" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3145654" xml-lang="en-US" level="2">Horizontal Line</paragraph> +<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="0.2201inch" height="0.2201inch"><alt id="alt_id3152872" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3155095" xml-lang="en-US" level="2">Vertical Line</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3153249" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3154540" xml-lang="en-US" level="2">Date Field</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3151010" xml-lang="en-US">Icon</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"/> +<paragraph role="heading" id="hd_id3151126" xml-lang="en-US" level="2">Time Field</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3147077" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3154733" xml-lang="en-US" level="2">Numeric Field</paragraph> +<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="0.0874inch" height="0.0874inch"><alt id="alt_id3147499" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3149870" xml-lang="en-US" level="2">Currency Field</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3150435" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3150117" xml-lang="en-US" level="2">Formatted Field</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3152807" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3156160" xml-lang="en-US" level="2">Pattern Field</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3150032" xml-lang="en-US">Icon</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"> +<paragraph role="heading" id="hd_id3146815" xml-lang="en-US" level="2">File Selection</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3149101" xml-lang="en-US">Icon</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> +<paragraph role="heading" id="hd_id3155912" xml-lang="en-US" level="2">Select</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3150653" xml-lang="en-US">Icon</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> +<paragraph role="heading" id="hd_id3154055" xml-lang="en-US" level="2">Properties</paragraph> +<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="0.1665inch" height="0.1665inch"><alt id="alt_id3146874" xml-lang="en-US">Icon</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> +<paragraph role="heading" id="hd_id3153746" xml-lang="en-US" level="2">Activate Test Mode</paragraph> +<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="0.222inch" height="0.222inch"><alt id="alt_id3148883" xml-lang="en-US">Icon</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"/><paragraph role="heading" id="hd_id2954191" xml-lang="en-US" level="2">Manage Language</paragraph> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id2320017" xml-lang="en-US"> +<image id="img_id2856837" src="cmd/sc_managelanguage.png" width="0.1665inch" height="0.1665inch"><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"/><paragraph role="heading" id="hd_id11902" xml-lang="en-US" level="2">Tree Control</paragraph> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id7511520" xml-lang="en-US"> +<image id="Graphic2" src="cmd/sc_inserttreecontrol.png" width="0.1665inch" height="0.1665inch"><alt id="alt_" xml-lang="en-US">Manage Language icon</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="0.1665inch" height="0.1665inch"><alt id="alt_" xml-lang="en-US">Table control icon</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id9961854" xml-lang="en-US" l10n="NEW"><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="0.1665inch" height="0.1665inch"><alt id="alt_" 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/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..5141854ee --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_euro.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="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> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><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></paragraph> + <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> + <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("Euro")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> 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..9a9a2e9e4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_gimmicks.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="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> + <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> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> 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..1fabfa162 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_script.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="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> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><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></paragraph> + <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#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("ScriptBindingLibrary")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</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..97a6935ae --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_tools.xhp @@ -0,0 +1,1600 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.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> + <table id="tab_id31529001004856"> + <tablerow> + <tablecell> + <paragraph id="par_id801529001004856" role="tablehead" xml-lang="en-US"><variable id="macro_name">Macro</variable></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41529001004856" role="tablehead" xml-lang="en-US"><variable id="call_param">Calling parameters and comments</variable></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711529001004857" role="bascode" xml-lang="en-US" localize="false">ActivateReadOnlyFlag</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id251529001003857" role="bascode" xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id71529001663903" role="bascode" xml-lang="en-US" localize="false">DeactivateReadOnlyFlag</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id951529001706210" role="bascode" xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag()</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421529001727178" role="bascode" xml-lang="en-US" localize="false">SetBasicReadOnlyFlag</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id771529001755355" role="bascode" xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id651529001954868" role="bascode" xml-lang="en-US" localize="false">WritedbgInfo</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id581529001865055" role="bascode" xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841529001994821" role="bascode" xml-lang="en-US" localize="false">WriteDbgString</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id171529002013434" role="bascode" xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as String)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741529002099962" role="bascode" xml-lang="en-US" localize="false">ShowArray</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id261529002118559" role="bascode" xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id321529002327444" role="bascode" xml-lang="en-US" localize="false">ShowPropertyValues</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id501529002327444" role="bascode" xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451529002368600" role="bascode" xml-lang="en-US" localize="false">ShowNameValuePair</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id321529002368600" role="bascode" xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id551529002415495" role="bascode" xml-lang="en-US" localize="false">ShowElementNames</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id111529003255859" xml-lang="en-US" localize="false">' Retrieves all the Elements of aSequence of an object, with the</paragraph> + <paragraph role="tablecontent" id="par_id41529003238747" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581529003295045" role="bascode" xml-lang="en-US" localize="false">ShowSupportedServiceNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851529003295045" role="tablecontent" xml-lang="en-US" localize="false">' Retrieves all the supported servicenames of an object, with the </paragraph> + <paragraph role="tablecontent" id="par_id301529003401893" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831529003429502" role="bascode" xml-lang="en-US" localize="false">ShowAvailableServiceNames</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id401529003494638" xml-lang="en-US" localize="false">' Retrieves all the available Servicenames of an object, with the</paragraph> + <paragraph role="tablecontent" id="par_id801529003504707" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591529003562090" role="bascode" xml-lang="en-US" localize="false">ShowCommands</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id791529003562091" role="bascode" xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881529003602892" role="bascode" xml-lang="en-US" localize="false">ProtectCurrentSheets</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id531529003602892" role="bascode" xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691529003635074" role="bascode" xml-lang="en-US" localize="false">FillDocument</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id371529003635074" role="bascode" xml-lang="en-US" localize="false">Sub FillDocument()</paragraph> + </bascode> + </tablecell> + </tablerow> + </table> + </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> + <table id="tab_id981529006338185"> + <tablerow> + <tablecell> + <paragraph id="par_id261529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#macro_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#call_param" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801529006604779" role="bascode" xml-lang="en-US" localize="false">RegisterNewDataSource</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id501529006725521" role="bascode" xml-lang="en-US" localize="false">ConnecttoDatabase</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id411529006832985" role="bascode" xml-lang="en-US" localize="false">GetStarOfficeLocale</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361529006902547" role="bascode" xml-lang="en-US" localize="false">GetRegistryKeyContent</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851529006965105" role="bascode" xml-lang="en-US" localize="false">GetProductname</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id451529006965105" role="bascode" xml-lang="en-US" localize="false">Function GetProductname() as String</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771529007007439" role="bascode" xml-lang="en-US" localize="false">OpenDocument</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id821529007072253" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id481529007130534" role="bascode" xml-lang="en-US" localize="false">TaskonDesktop</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id911529007130534" role="bascode" xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201529007205755" role="bascode" xml-lang="en-US" localize="false">RetrieveFileName</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id81529007245965" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id121529007269721" role="bascode" xml-lang="en-US" localize="false">GetPathSettings</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id801529007338550" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571529007381828" role="bascode" xml-lang="en-US" localize="false">GetOfficeSubPath</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id761529007616982" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591529007658281" role="bascode" xml-lang="en-US" localize="false">ShowNoOfficePathError</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id511529007658281" role="bascode" xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431529007692356" role="bascode" xml-lang="en-US" localize="false">InitResources</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id611529007790857" role="bascode" xml-lang="en-US" localize="false">GetResText</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id331529007790857" role="bascode" xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As string</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971529007839780" role="bascode" xml-lang="en-US" localize="false">CutPathView</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id51529007902118" role="bascode" xml-lang="en-US" localize="false">DeleteInputCells</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id311529007997114" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881529008035409" role="bascode" xml-lang="en-US" localize="false">ChangeValueofRange</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id261529008090521" xml-lang="en-US" localize="false">' Inserts a certain String to all cells of a Range that ist 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547275154" role="bascode" localize="false" xml-lang="en-US">ReplaceRangeValues</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054727953" role="bascode" localize="false" xml-lang="en-US">GetValueofCellbyName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547271480" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547273177" role="bascode" localize="false" xml-lang="en-US">DuplicateRow</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547271951" role="bascode" localize="false" xml-lang="en-US">GetStringofCellbyName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547275159" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547271528" role="bascode" localize="false" xml-lang="en-US">GetCellByName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547271588" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547288062" role="bascode" localize="false" xml-lang="en-US">ChangeCellValue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547288384" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547283259" role="bascode" localize="false" xml-lang="en-US">GetDocumentType</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547286797" role="bascode" localize="false" xml-lang="en-US">Function GetDocumentType(oDocument)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547288146" role="bascode" localize="false" xml-lang="en-US">GetNumberFormatType</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547282335" role="bascode" localize="false" xml-lang="en-US">ProtectSheets</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547283563" role="bascode" localize="false" xml-lang="en-US">Sub ProtectSheets(Optional oSheets as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547285130" role="bascode" localize="false" xml-lang="en-US">UnprotectSheets</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547289761" role="bascode" localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional oSheets as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547284142" role="bascode" localize="false" xml-lang="en-US">GetRowIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547284556" role="bascode" localize="false" xml-lang="en-US">GetColumnIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547285141" role="bascode" localize="false" xml-lang="en-US">CopySheetbyName</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id0614201805472944" role="bascode" localize="false" xml-lang="en-US">ToggleWindow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547292068" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547294361" role="bascode" localize="false" xml-lang="en-US">CheckNewSheetname</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547298278" role="bascode" localize="false" xml-lang="en-US">AddNewSheetName</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547293964" role="bascode" localize="false" xml-lang="en-US">GetSheetIndex</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id06142018054729713" role="bascode" localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as Integer</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547298034" role="bascode" localize="false" xml-lang="en-US">GetLastUsedRow</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547299520" role="bascode" localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547294665" role="bascode" localize="false" xml-lang="en-US">ModifyBorderLineWidth</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547295117" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054729303" role="bascode" localize="false" xml-lang="en-US">AttachBasicMacroToEvent</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547308735" role="bascode" localize="false" xml-lang="en-US">ModifyPropertyValue</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054730528" role="bascode" localize="false" xml-lang="en-US">GetPropertyValueIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547305379" role="bascode" localize="false" xml-lang="en-US">DispatchSlot</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547302087" role="bascode" localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as Integer)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547308065" role="bascode" localize="false" xml-lang="en-US">IsFatOffice</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547306757" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054730408" role="bascode" localize="false" xml-lang="en-US">GetLocale</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547305357" role="bascode" localize="false" xml-lang="en-US">ToggleDesignMode</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547301559" role="bascode" localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547301521" role="bascode" localize="false" xml-lang="en-US">isHighContrast</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180547302307" role="bascode" localize="false" xml-lang="en-US">Function isHighContrast(oPeer as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547302524" role="bascode" localize="false" xml-lang="en-US">CreateNewDocument</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547306821" role="bascode" localize="false" xml-lang="en-US">DisposeDocument</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547308844" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547316190" role="bascode" localize="false" xml-lang="en-US">CalIsLeapYear</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547311590" role="tablecontent" 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> + </tablecell> + </tablerow> + </table> + </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> + <table id="Tabela1"> + <tablerow> + <tablecell> + <paragraph id="par_id261529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#macro_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#call_param" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728405758" role="bascode" localize="false" xml-lang="en-US">GetControlShape</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728404186" role="tablecontent" 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="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728401929" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728402154" role="bascode" localize="false" xml-lang="en-US">getControlView</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728406447" role="tablecontent" localize="false" xml-lang="en-US">' Returns the View of a Control</paragraph> + <paragraph id="par_id061520180728405250" role="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728407354" role="tablecontent" 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="tablecontent" localize="false" xml-lang="en-US">' The 'oController' is always directly attached to the Document</paragraph> + <paragraph id="par_id061520180728401894" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728409398" role="bascode" localize="false" xml-lang="en-US">DisposeControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728406445" role="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728405024" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728401986" role="bascode" localize="false" xml-lang="en-US">GetControlGroupModel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728404727" role="tablecontent" 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="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728404995" role="bascode" localize="false" xml-lang="en-US">GetRefValue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id06152018072840427" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06152018072841458" role="bascode" localize="false" xml-lang="en-US">GetRefValueOfControlGroup</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728416653" role="bascode" localize="false" xml-lang="en-US">GetOptionGroupValue</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728419761" role="bascode" localize="false" xml-lang="en-US">WriteOptValueToCell</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728411084" role="bascode" localize="false" xml-lang="en-US">LoadDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728417528" role="bascode" localize="false" xml-lang="en-US">GetFolderName</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061520180728414273" role="bascode" localize="false" xml-lang="en-US">Sub GetFolderName(oRefModel as Object)</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728412942" role="bascode" localize="false" xml-lang="en-US">GetFileName</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728414394" role="bascode" localize="false" xml-lang="en-US">StoreDocument</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728424363" role="bascode" localize="false" xml-lang="en-US">AddFiltersToDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728422388" role="bascode" localize="false" xml-lang="en-US">SwitchMousePointer</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728428854" role="bascode" localize="false" xml-lang="en-US">ShowOverwriteAllDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728429649" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToQuery</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061520180728429597" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToQuery()</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728428255" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToAlways</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061520180728424733" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToAlways()</paragraph> + </bascode> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06152018072842702" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToNever</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061520180728429250" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToNever()</paragraph> + </bascode> + </tablecell> + </tablerow> + </table> + </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> + <table id="Tabela18"> + <tablerow> + <tablecell> + <paragraph id="par_id261529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#macro_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#call_param" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708276674" role="bascode" localize="false" xml-lang="en-US">ElimChar</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708279224" role="bascode" localize="false" xml-lang="en-US">DeleteStr</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708275363" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708308611" role="bascode" localize="false" xml-lang="en-US">FindPartString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708308479" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070830220" role="bascode" localize="false" xml-lang="en-US">PartStringInArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708302715" role="tablecontent" localize="false" xml-lang="en-US">' Note iCompare = 0 (Binary comparison)</paragraph> + <paragraph id="par_id06142018070830615" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708307208" role="bascode" localize="false" xml-lang="en-US">RTrimStr</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708304034" role="tablecontent" localize="false" xml-lang="en-US">' Deletes the String 'SmallString' out of the String 'BigString'</paragraph> + <paragraph id="par_id06142018070830656" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708314304" role="bascode" localize="false" xml-lang="en-US">LTRimChar</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708318862" role="tablecontent" localize="false" xml-lang="en-US">' Deletes the Char 'CompChar' out of the String 'BigString'</paragraph> + <paragraph id="par_id061420180708319364" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708314113" role="bascode" localize="false" xml-lang="en-US">ArrayOutOfString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708315726" role="tablecontent" localize="false" xml-lang="en-US">' Retrieves an Array out of a String.</paragraph> + <paragraph id="par_id061420180708316680" role="tablecontent" 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="tablecontent" localize="false" xml-lang="en-US">' in the Array</paragraph> + <paragraph id="par_id061420180708318872" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708313207" role="bascode" localize="false" xml-lang="en-US">ClearArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id06142018070831823" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708315939" role="bascode" localize="false" xml-lang="en-US">ClearMultiDimArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708319653" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id0614201807083186" role="bascode" localize="false" xml-lang="en-US">FieldinArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708316541" role="tablecontent" localize="false" xml-lang="en-US">' Checks if a Field (LocField) is already defined in an Array</paragraph> + <paragraph id="par_id061420180708319616" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708311512" role="bascode" localize="false" xml-lang="en-US">FieldinList</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708322561" role="tablecontent" localize="false" xml-lang="en-US">' Checks if a Field (LocField) is already defined in an Array</paragraph> + <paragraph id="par_id061420180708329146" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708323374" role="bascode" localize="false" xml-lang="en-US">IndexinArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708321488" role="tablecontent" localize="false" xml-lang="en-US">' Retrieves the Index of the delivered String 'SearchString' in</paragraph> + <paragraph id="par_id061420180708323577" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708324642" role="bascode" localize="false" xml-lang="en-US">MultiArrayInListbox</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708325766" role="bascode" localize="false" xml-lang="en-US">StringInMultiArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708328772" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708327934" role="bascode" localize="false" xml-lang="en-US">GetIndexInMultiArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id06142018070832514" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708336858" role="bascode" localize="false" xml-lang="en-US">GetIndexForPartString_</paragraph> + <paragraph role="bascode" id="par_id971529015773531" xml-lang="en-US" localize="false">inMultiArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708337261" role="tablecontent" 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="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708331666" role="bascode" localize="false" xml-lang="en-US">ArrayfromMultiArray</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708335847" role="bascode" localize="false" xml-lang="en-US">ReplaceString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708332382" role="tablecontent" localize="false" xml-lang="en-US">' Replaces the string "OldReplace" through the String "NewReplace" in the String</paragraph> + <paragraph id="par_id061420180708334998" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708336841" role="bascode" localize="false" xml-lang="en-US">FindSecondValue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708337504" role="tablecontent" localize="false" xml-lang="en-US">' Retrieves the second value for a next to 'SearchString' in</paragraph> + <paragraph id="par_id061420180708335341" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708339122" role="bascode" localize="false" xml-lang="en-US">Power</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708332948" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id0614201807083362" role="bascode" localize="false" xml-lang="en-US">Round</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708349543" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708344826" role="bascode" localize="false" xml-lang="en-US">FileNameoutofPath</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708348505" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070834616" role="bascode" localize="false" xml-lang="en-US">GetFileNameExtension</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708342472" role="bascode" localize="false" xml-lang="en-US">GetFileNameWithoutExtension</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708347642" role="bascode" localize="false" xml-lang="en-US">DirectoryNameoutofPath</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708348485" role="bascode" localize="false" xml-lang="en-US">CountCharsinString</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708344129" role="bascode" localize="false" xml-lang="en-US">BubbleSortList</paragraph> + </tablecell> + <tablecell> + <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="tablecontent" localize="false" xml-lang="en-US">'This function bubble sorts an array of maximum 2 dimensions.</paragraph> + <paragraph id="par_id061420180708351446" role="tablecontent" localize="false" xml-lang="en-US">'The default sorting order is the first dimension</paragraph> + <paragraph id="par_id061420180708359513" role="tablecontent" localize="false" xml-lang="en-US">'Only if sort2ndValue is True the second dimension is the relevant for the sorting order</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708356687" role="bascode" localize="false" xml-lang="en-US">GetValueoutofList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070835957" role="bascode" localize="false" xml-lang="en-US">AddListtoList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070835769" role="bascode" localize="false" xml-lang="en-US">CheckDouble</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180708359797" role="bascode" localize="false" xml-lang="en-US">Function CheckDouble(DoubleString as String)</paragraph> + </bascode> + </tablecell> + </tablerow> + </table> + </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> + <table id="Tabela19"> + <tablerow> + <tablecell> + <paragraph id="par_id261529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#macro_name" markup="ignore"/></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581529006338185" role="tablehead" xml-lang="en-US" localize="false"><embedvar href="text/sbasic/shared/03/lib_tools.xhp#call_param" markup="ignore"/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727434845" role="bascode" localize="false" xml-lang="en-US">ReadDirectories</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727437838" role="bascode" localize="false" xml-lang="en-US">AddFoldertoList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727432439" role="bascode" localize="false" xml-lang="en-US">AddFileNameToList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727448222" role="bascode" localize="false" xml-lang="en-US">RetrieveDocTitle</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727441588" role="bascode" localize="false" xml-lang="en-US">GetRealFileContent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180727444743" role="tablecontent" localize="false" xml-lang="en-US">' Retrieves The Filecontent of a Document by extracting the content</paragraph> + <paragraph id="par_id061420180727441850" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727441712" role="bascode" localize="false" xml-lang="en-US">CopyRecursively</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727445345" role="bascode" localize="false" xml-lang="en-US">ShowHelperDialog</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180727445226" role="tablecontent" 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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727442283" role="bascode" localize="false" xml-lang="en-US">SaveDataToFile</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727442501" role="bascode" localize="false" xml-lang="en-US">LoadDataFromFile</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018072744521" role="bascode" localize="false" xml-lang="en-US">CreateFolder</paragraph> + </tablecell> + <tablecell> + <bascode> + <paragraph id="par_id061420180727443924" role="bascode" localize="false" xml-lang="en-US">Function CreateFolder(sNewFolder) as Boolean</paragraph> + </bascode> + </tablecell> + </tablerow> + </table> + </section> + <section id="relatedTopics"> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + </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..46d180104 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03000000.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="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"> + +<paragraph id="hd_id3152895" role="heading" level="1" xml-lang="en-US"><variable id="doc_title"><link href="text/sbasic/shared/03000000.xhp" name="Run-Time Functions">Run-Time Functions</link></variable></paragraph> +<paragraph id="par_id3148983" role="paragraph" xml-lang="en-US">This section describes the Runtime Functions of <item type="productname">%PRODUCTNAME</item> Basic.</paragraph> +</section> +<embed href="text/sbasic/shared/03040000.xhp#basic_constants"/> +<embed href="text/sbasic/shared/03010000.xhp#bildschirmeinaus"/> +<embed href="text/sbasic/shared/03020000.xhp#dateieinaus"/> +<embed href="text/sbasic/shared/03030000.xhp#datumzeit"/> +<embed href="text/sbasic/shared/03050000.xhp#fehlerbehan"/> +<embed href="text/sbasic/shared/03060000.xhp#logi"/> +<embed href="text/sbasic/shared/03070000.xhp#mathe"/> +<embed href="text/sbasic/shared/03080000.xhp#nummer"/> +<embed href="text/sbasic/shared/03090000.xhp#programmablauf"/> +<embed href="text/sbasic/shared/03100000.xhp#variablen"/> +<embed href="text/sbasic/shared/03110000.xhp#vergleich"/> +<embed href="text/sbasic/shared/03120000.xhp#zeichen"/> +<embed href="text/sbasic/shared/03130000.xhp#sonstige"/> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03010000.xhp b/helpcontent2/source/text/sbasic/shared/03010000.xhp new file mode 100644 index 000000000..60039275d --- /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="bildschirmeinaus"> + <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#ausgabe"/> + <embed href="text/sbasic/shared/03010200.xhp#eingabe"/> + <embed href="text/sbasic/shared/03010300.xhp#farbe"/> + </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..f9fb1bb0f --- /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="ausgabe"> + <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..095976844 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010101.xhp @@ -0,0 +1,223 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3154927" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010101.xhp">MsgBox Statement</link></paragraph> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US">Displays a dialog box containing a message.</paragraph> +</section> + +<paragraph id="hd_id3153897" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3148664" role="bascode" xml-lang="en-US">MsgBox Text As String [,Type As Integer [,Dialogtitle As String]] (As Statement) or MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]]) (As Function)</paragraph> +</bascode> + +<paragraph id="hd_id3153361" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<paragraph id="par_id3148798" role="paragraph" xml-lang="en-US"> <emph>Text</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>DialogTitle</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>Type</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>Type</emph> represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values:</paragraph> + +<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_ABORTRETRYCANCEL</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> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3150715" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..68eeba306 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010102.xhp @@ -0,0 +1,320 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3153379" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010102.xhp" name="MsgBox Function">MsgBox Function</link></paragraph> +<paragraph id="par_id3145171" role="paragraph" xml-lang="en-US">Displays a dialog box containing a message and returns a value.</paragraph> +</section> + +<paragraph id="hd_id3156281" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154685" role="bascode" xml-lang="en-US">MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]])</paragraph> +</bascode> + +<paragraph id="hd_id3153771" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3153363" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<paragraph id="par_id3153727" role="paragraph" xml-lang="en-US"> <emph>Text</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph> +<paragraph id="par_id3147317" role="paragraph" xml-lang="en-US"> <emph>DialogTitle</emph>: String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed.</paragraph> +<paragraph id="par_id3153954" role="paragraph" xml-lang="en-US"> <emph>Type</emph>: Any integer expression that specifies the dialog type and defines the number and type of buttons or icons displayed. <emph>Type</emph> represents a combination of bit patterns (dialog elements defined by adding the respective values):</paragraph> +<paragraph id="par_id3154319" role="paragraph" xml-lang="en-US"> <emph>Values</emph> </paragraph> + +<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_ABORTRETRYCANCEL</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> + +<paragraph id="par_id3159267" role="paragraph" xml-lang="en-US"> <emph>Return value:</emph> </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_ABORTRETRYCANCEL, "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..52cccd7ec --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010103.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="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> + + +<paragraph id="hd_id3147230" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010103.xhp" name="Print Statement">Print Statement</link></paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">Outputs the specified strings or numeric expressions to a dialog or to a file.</paragraph> +</section> + +<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" xml-lang="en-US">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" xml-lang="en-US"> <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" xml-lang="en-US"> <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" xml-lang="en-US"> <emph>number</emph>: Number of spaces to be inserted by the <emph>Spc</emph> function.</paragraph> +<paragraph id="par_id3145364" role="paragraph" xml-lang="en-US"> <emph>pos</emph>: Spaces are inserted until the specified position.</paragraph> +<paragraph id="par_id3154319" role="paragraph" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">Sub ExamplePrint</paragraph> +<paragraph id="par_idm1073160528" role="bascode" localize="false" xml-lang="en-US"> Print "ABC"</paragraph> +<paragraph id="par_idm1073159296" role="bascode" localize="false" xml-lang="en-US"> Print "ABC","123"</paragraph> +<paragraph id="par_idm1073129856" role="bascode" localize="false" xml-lang="en-US"> i = FreeFile()</paragraph> +<paragraph id="par_idm1073128624" role="bascode" localize="false" xml-lang="en-US"> Open "C:\Temp.txt" For Output As i</paragraph> +<paragraph id="par_idm1073127376" role="bascode" localize="false" xml-lang="en-US"> Print #i, "ABC"</paragraph> +<paragraph id="par_idm1073126144" role="bascode" localize="false" xml-lang="en-US"> Close #i</paragraph> +<paragraph id="par_idm1073124912" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</case> +<default> +<bascode> +<paragraph id="par_idm1073122912" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePrint</paragraph> +<paragraph id="par_idm1073121680" role="bascode" localize="false" xml-lang="en-US"> Print "ABC"</paragraph> +<paragraph id="par_idm1073120448" role="bascode" localize="false" xml-lang="en-US"> Print "ABC","123"</paragraph> +<paragraph id="par_idm1073119216" role="bascode" localize="false" xml-lang="en-US"> i = FreeFile()</paragraph> +<paragraph id="par_idm1073117984" role="bascode" localize="false" xml-lang="en-US"> Open "~/temp.txt" For Output As i</paragraph> +<paragraph id="par_idm1073116736" role="bascode" localize="false" xml-lang="en-US"> Print #i, "ABC"</paragraph> +<paragraph id="par_idm1073115504" role="bascode" localize="false" xml-lang="en-US"> Close #i</paragraph> +<paragraph id="par_idm1073114272" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</default> +</switch> +</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..5464dbaf0 --- /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="eingabe"> + <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..353d6a442 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010201.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="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> + + +<paragraph id="hd_id3148932" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function">InputBox Function</link></paragraph> +<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> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3159201" role="bascode" xml-lang="en-US">InputBox (Msg As String[, Title As String[, Default As String[, x_pos As Integer, y_pos As Integer]]]]) </paragraph> +</bascode> + +<paragraph id="hd_id3150713" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3149346" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US"> <emph>Msg</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>x_pos</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 the office application.</paragraph> +<paragraph id="par_id3156024" role="paragraph" xml-lang="en-US"> <emph>y_pos</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 the office application.</paragraph> +<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US">If <emph>x_pos</emph> and <emph>y_pos</emph> 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> + +<paragraph id="hd_id3149456" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..0e06f5dc3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010300.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="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="farbe"> + <paragraph id="hd_id3157896" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010300.xhp" name="Color Functions">Color Functions</link></paragraph> + <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"/> + </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..7fd30d055 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010301.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="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> + + +<paragraph id="hd_id3149180" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010301.xhp" name="Blue Function">Blue Function</link></paragraph> +<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns the blue component of the specified composite color code.</paragraph> +</section> + +<paragraph id="hd_id3149670" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149457" role="bascode" xml-lang="en-US">Blue (Color As Long)</paragraph> +</bascode> + +<paragraph id="hd_id3149656" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3156423" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<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> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/03010303.xhp#ColorPickerDialog"/> + +<paragraph id="hd_id3153091" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..f5630fde7 --- /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> + + +<paragraph id="hd_id3148947" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010302.xhp" name="Green Function">Green Function</link></paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">Returns the Green component of the given composite color code.</paragraph> +</section> + +<paragraph id="hd_id3154140" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153969" role="bascode" xml-lang="en-US">Green (Color As Long)</paragraph> +</bascode> + +<paragraph id="hd_id3154124" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153194" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3154909" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<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"/> + +<paragraph id="hd_id3149664" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03010303.xhp b/helpcontent2/source/text/sbasic/shared/03010303.xhp new file mode 100644 index 000000000..1dfc411f0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010303.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="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> + + +<paragraph id="hd_id3148947" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010303.xhp" name="Red Function">Red Function</link></paragraph> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Returns the Red component of the specified composite color code.</paragraph> +</section> + +<paragraph id="hd_id3148799" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150448" role="bascode" xml-lang="en-US">Red (ColorNumber As Long)</paragraph> +</bascode> + +<paragraph id="hd_id3151042" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3145173" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3154685" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<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> +<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> + +<paragraph id="hd_id3148575" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03010304.xhp b/helpcontent2/source/text/sbasic/shared/03010304.xhp new file mode 100644 index 000000000..2e78f7ccf --- /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> + +<paragraph id="hd_id3149670" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010304.xhp" name="QBColor Function">QBColor Function</link></paragraph> +<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> + +<paragraph id="hd_id3154140" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<paragraph id="par_id3151042" role="code" xml-lang="en-US">QBColor (ColorNumber As Integer)</paragraph> + +<paragraph id="hd_id3145172" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Long</paragraph> + +<paragraph id="hd_id3156560" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<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"/> + +<paragraph id="hd_id3148406" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..337e07992 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010305.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="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> + +<paragraph id="hd_id3150792" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010305.xhp" name="RGB Function">RGB Function</link></paragraph> + <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> + +<paragraph id="hd_id3147229" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">RGB (Red, Green, Blue)</paragraph> +</bascode> + +<paragraph id="hd_id3156442" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3159153" role="paragraph" xml-lang="en-US">Long</paragraph> + +<paragraph id="hd_id3154013" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<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> +<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> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147435" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020000.xhp b/helpcontent2/source/text/sbasic/shared/03020000.xhp new file mode 100644 index 000000000..f4d1cb285 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020000.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="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="dateieinaus"> +<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/03020100.xhp#oeffnen"/> +<embed href="text/sbasic/shared/03020200.xhp#eingabeeinaus"/> +<embed href="text/sbasic/shared/03020400.xhp#organisation"/> +</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..a23a1242e --- /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="oeffnen"> +<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..608027d66 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020101.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="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> + + +<paragraph id="hd_id3157896" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020101.xhp" name="Close Statement">Close Statement</link></paragraph> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US">Closes a specified file that was opened with the Open statement.</paragraph> +</section> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147265" role="bascode" xml-lang="en-US">Close FileNumber As Integer[, FileNumber2 As Integer[,...]] </paragraph> +</bascode> + +<paragraph id="hd_id3153379" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</emph> Any integer expression that specifies the number of the data channel that was opened with the <emph>Open</emph> statement.</paragraph> + +<paragraph id="hd_id3153192" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341290400" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm1341289152" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341287920" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1341286688" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1341285456" role="bascode" localize="false" xml-lang="en-US">Dim sMsg As String</paragraph> +<paragraph id="par_idm1341284224" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1341282976" role="bascode" localize="false" xml-lang="en-US"> sMsg = ""</paragraph> +<paragraph id="par_idm1341281744" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341280512" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3153727" role="bascode" xml-lang="en-US"> Print #iNumber, "First line of text"</paragraph> +<paragraph id="par_id3147350" role="bascode" xml-lang="en-US"> Print #iNumber, "Another line of text"</paragraph> +<paragraph id="par_idm1340923792" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340922560" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1340921328" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1340920080" role="bascode" localize="false" xml-lang="en-US"> While Not eof(iNumber)</paragraph> +<paragraph id="par_idm1340918832" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1340917584" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1340916336" role="bascode" localize="false" xml-lang="en-US"> sMsg = sMsg & sLine & chr(13)</paragraph> +<paragraph id="par_idm1340915072" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1340913840" role="bascode" localize="false" xml-lang="en-US"> Wend</paragraph> +<paragraph id="par_idm1340912608" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340911376" role="bascode" localize="false" xml-lang="en-US"> MsgBox sMsg</paragraph> +<paragraph id="par_idm1340910144" 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/03020102.xhp b/helpcontent2/source/text/sbasic/shared/03020102.xhp new file mode 100644 index 000000000..66160f95e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020102.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="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"><link href="text/sbasic/shared/03020102.xhp" name="FreeFile Function">FreeFile Function</link></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> + +<paragraph id="hd_id3150769" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_idm1341602048" role="bascode" localize="false" xml-lang="en-US">FreeFile</paragraph> +</bascode> + +<paragraph id="hd_id3151042" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3148576" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3159153" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341589136" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm1341587888" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341586656" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1341585424" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1341584192" role="bascode" localize="false" xml-lang="en-US">Dim sMsg As String</paragraph> +<paragraph id="par_idm1341582960" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1341581712" role="bascode" localize="false" xml-lang="en-US"> sMsg = ""</paragraph> +<paragraph id="par_idm1341580480" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341579248" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3155416" role="bascode" xml-lang="en-US"> Print #iNumber, "First line of text"</paragraph> +<paragraph id="par_id3153416" role="bascode" xml-lang="en-US"> Print #iNumber, "Another line of text"</paragraph> +<paragraph id="par_idm1341574464" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341573232" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341572000" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As #iNumber</paragraph> +<paragraph id="par_idm1341570752" role="bascode" localize="false" xml-lang="en-US"> While Not eof(#iNumber)</paragraph> +<paragraph id="par_idm1341569504" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1341568256" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1341567008" role="bascode" localize="false" xml-lang="en-US"> sMsg = sMsg & sLine & chr(13)</paragraph> +<paragraph id="par_idm1341565744" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341564512" role="bascode" localize="false" xml-lang="en-US"> Wend</paragraph> +<paragraph id="par_idm1341563280" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341562048" role="bascode" localize="false" xml-lang="en-US"> MsgBox sMsg</paragraph> +<paragraph id="par_idm1341560816" 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/03020103.xhp b/helpcontent2/source/text/sbasic/shared/03020103.xhp new file mode 100644 index 000000000..14daf4955 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020103.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="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"><link href="text/sbasic/shared/03020103.xhp" name="Open Statement">Open Statement</link></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"/> +<bascode> +<paragraph id="par_id3154124" localize="false" role="bascode" xml-lang="en-US">Open FileName As String [For Mode] [Access IOMode] [Protected] As [#]FileNumber As Integer [Len = DatasetLength]<comment>i37502</comment></paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3155132" role="paragraph" xml-lang="en-US"> <emph>FileName: </emph>Name and path 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: Append (append to sequential file), Binary (data can be accessed by bytes using Get and Put), Input (opens data channel for reading), Output (opens data channel for writing), and Random (edits relative files).</paragraph> +<paragraph id="par_id3154014" role="paragraph" xml-lang="en-US"> <emph>IOMode:</emph> Keyword that defines the access type. Valid values: Read (read-only), Write (write-only), Read Write (both).</paragraph> +<paragraph id="par_id3150011" role="paragraph" xml-lang="en-US"> <emph>Protected:</emph> Keyword that defines the security status of a file after opening. Valid values: Shared (file may be opened by other applications), Lock Read (file is protected against reading), Lock Write (file is protected against writing), Lock Read Write (denies file access).</paragraph> +<paragraph id="par_id3153190" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</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>DatasetLength:</emph> For random 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"/> +<bascode> +<paragraph id="par_idm1341597584" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm1341596336" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341595104" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1341593872" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1341592640" role="bascode" localize="false" xml-lang="en-US">Dim sMsg As String</paragraph> +<paragraph id="par_idm1341591408" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1341590160" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341588928" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341582912" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341581680" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1341580432" role="bascode" localize="false" xml-lang="en-US"> While Not eof(iNumber)</paragraph> +<paragraph id="par_idm1341579184" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1341577936" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1341576688" role="bascode" localize="false" xml-lang="en-US"> sMsg = sMsg & sLine & chr(13)</paragraph> +<paragraph id="par_idm1341575424" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341574192" role="bascode" localize="false" xml-lang="en-US"> Wend</paragraph> +<paragraph id="par_idm1341572960" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341571728" role="bascode" localize="false" xml-lang="en-US"> MsgBox sMsg</paragraph> +<paragraph id="par_idm1341570496" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020104.xhp b/helpcontent2/source/text/sbasic/shared/03020104.xhp new file mode 100644 index 000000000..d6d2074a9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020104.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="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> + + +<paragraph id="hd_id3154141" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020104.xhp">Reset Statement</link></paragraph> +<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> + +<paragraph id="hd_id3154124" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_idm1207263392" role="bascode" localize="false" xml-lang="en-US">Reset</paragraph> +</bascode> + +<paragraph id="hd_id3161831" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1207260032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleReset</paragraph> +<paragraph id="par_idm1207243568" role="bascode" localize="false" xml-lang="en-US">On Error GoTo ErrorHandler</paragraph> +<paragraph id="par_idm1207242464" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1207241360" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph> +<paragraph id="par_idm1207240256" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1207239152" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1207238048" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1207236896" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1207235792" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1207231888" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1207230784" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1207229632" role="bascode" localize="false" xml-lang="en-US"> For iCount = 1 To 5</paragraph> +<paragraph id="par_idm1207228528" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1207227376" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1207226224" role="bascode" localize="false" xml-lang="en-US"> Rem</paragraph> +<paragraph id="par_idm1207225120" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1207224016" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_idm1207222912" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1207221808" role="bascode" localize="false" xml-lang="en-US"> Exit Sub</paragraph> +<paragraph id="par_idm1207220704" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph> +<paragraph id="par_idm1207219600" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..e2a230376 --- /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="eingabeeinaus"> +<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..eb46b84dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020201.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="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> + + +<paragraph id="hd_id3154927" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020201.xhp">Get Statement</link></paragraph> +<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> + +<paragraph id="hd_id3150358" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150792" role="bascode" xml-lang="en-US">Get [#] FileNumber As Integer, [Position], Variable</paragraph> +</bascode> + +<paragraph id="hd_id3154138" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</emph> Any integer expression that determines the file number.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US"> <emph>Position:</emph> For files opened in Random mode, <emph>Position</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>Position</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>Position</emph> is 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">Variable: Name of the variable to be read. With the exception of object variables, you can use any variable type.</paragraph> + +<paragraph id="hd_id3153144" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340774864" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomAccess</paragraph> +<paragraph id="par_idm1340773632" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1340769376" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1340768128" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1340766896" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> Seek #iNumber,2</paragraph> +<paragraph id="par_idm1340757344" role="bascode" localize="false" xml-lang="en-US"> Get #iNumber,,sText</paragraph> +<paragraph id="par_idm1340756112" role="bascode" localize="false" xml-lang="en-US"> Print sText</paragraph> +<paragraph id="par_idm1340754880" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340753648" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1340752416" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Random As #iNumber Len=32</paragraph> +<paragraph id="par_idm1340751152" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> Get #iNumber,1,sText</paragraph> +<paragraph id="par_idm1340746928" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> Print Lof(#iNumber)</paragraph> +<paragraph id="par_idm1340742704" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340741472" 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/03020202.xhp b/helpcontent2/source/text/sbasic/shared/03020202.xhp new file mode 100644 index 000000000..b84c2dc82 --- /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"><link href="text/sbasic/shared/03020202.xhp" name="Input# Statement">Input# Statement</link></paragraph> +<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">Reads data from an open sequential file.</paragraph> +</section> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<paragraph id="par_id3150440" role="code" xml-lang="en-US">Input #FileNumber As Integer; var1[, var2[, var3[,...]]]</paragraph> + +<paragraph id="hd_id3146121" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145749" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</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" xml-lang="en-US"> <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" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">If the end of the file is reached while reading a data element, an error occurs and the process is aborted.</paragraph> + +<paragraph id="hd_id3152578" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm871097888" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm871096912" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph> +<paragraph id="par_idm871095952" role="bascode" localize="false" xml-lang="en-US">Dim sName As String</paragraph> +<paragraph id="par_idm871094992" role="bascode" localize="false" xml-lang="en-US">Dim sValue As Integer</paragraph> +<paragraph id="par_idm871094032" role="bascode" localize="false" xml-lang="en-US">Dim sFileName As String</paragraph> +<paragraph id="par_idm871093072" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm871092096" role="bascode" localize="false" xml-lang="en-US">sFileName = "c:\data.txt"</paragraph> +<paragraph id="par_idm871091120" role="bascode" localize="false" xml-lang="en-US">iCount = Freefile</paragraph> +<paragraph id="par_idm871090160" role="bascode" localize="false" xml-lang="en-US"> </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" xml-lang="en-US">Open sFileName For Output As iCount</paragraph> +<paragraph id="par_idm871086976" role="bascode" localize="false" xml-lang="en-US">sName = "Hamburg"</paragraph> +<paragraph id="par_idm871086016" role="bascode" localize="false" xml-lang="en-US">sValue = 200</paragraph> +<paragraph id="par_idm871085056" role="bascode" localize="false" xml-lang="en-US">Write #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871084080" role="bascode" localize="false" xml-lang="en-US">sName = "New York"</paragraph> +<paragraph id="par_idm871083120" role="bascode" localize="false" xml-lang="en-US">sValue = 300</paragraph> +<paragraph id="par_idm871082160" role="bascode" localize="false" xml-lang="en-US">Write #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871081184" role="bascode" localize="false" xml-lang="en-US">sName = "Miami"</paragraph> +<paragraph id="par_idm871080224" role="bascode" localize="false" xml-lang="en-US">sValue = 459</paragraph> +<paragraph id="par_idm871079264" role="bascode" localize="false" xml-lang="en-US">Write #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871078288" role="bascode" localize="false" xml-lang="en-US">Close #iCount</paragraph> +<paragraph id="par_idm871077328" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm871076400" role="bascode" localize="false" xml-lang="en-US">iCount = Freefile</paragraph> +<paragraph id="par_id4144766" role="bascode" xml-lang="en-US">' Read data file using Input</paragraph> +<paragraph id="par_idm871074192" role="bascode" localize="false" xml-lang="en-US">Open sFileName For Input As iCount</paragraph> +<paragraph id="par_idm871073216" role="bascode" localize="false" xml-lang="en-US">Input #iCount; sName, sValue</paragraph> +<paragraph id="par_idm871072240" role="bascode" localize="false" xml-lang="en-US">MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871071264" role="bascode" localize="false" xml-lang="en-US">Input #iCount; sName, sValue</paragraph> +<paragraph id="par_idm871070288" role="bascode" localize="false" xml-lang="en-US">MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871069312" role="bascode" localize="false" xml-lang="en-US">Input #iCount; sName, sValue</paragraph> +<paragraph id="par_idm871068336" role="bascode" localize="false" xml-lang="en-US">MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871067360" role="bascode" localize="false" xml-lang="en-US">Close #iCount</paragraph> +<paragraph id="par_idm871066400" 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/03020203.xhp b/helpcontent2/source/text/sbasic/shared/03020203.xhp new file mode 100644 index 000000000..2bb424393 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020203.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="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> + + +<paragraph id="hd_id3153361" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020203.xhp" name="Line Input # Statement">Line Input # Statement</link></paragraph> +<paragraph id="par_id3156280" role="paragraph" xml-lang="en-US">Reads strings from a sequential file into a variable.</paragraph> +</section> + +<paragraph id="hd_id3150447" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147229" role="bascode" xml-lang="en-US">Line Input #FileNumber As Integer, Var As String </paragraph> +</bascode> + +<paragraph id="hd_id3145173" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3161832" role="paragraph" xml-lang="en-US"> <emph>FileNumber: </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>var:</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> + +<paragraph id="hd_id3163711" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340596256" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm1340595008" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1340593776" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1340592544" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1340591312" role="bascode" localize="false" xml-lang="en-US">Dim sMsg As String</paragraph> +<paragraph id="par_idm1340590080" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1340588832" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1340587600" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3147124" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> +<paragraph id="par_id3153415" role="bascode" xml-lang="en-US"> Print #iNumber, "This is another line of text"</paragraph> +<paragraph id="par_idm1340582816" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340581584" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1340580352" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1340579104" role="bascode" localize="false" xml-lang="en-US"> While Not EOF(iNumber)</paragraph> +<paragraph id="par_idm1340577856" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1340576608" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1340575360" role="bascode" localize="false" xml-lang="en-US"> sMsg = sMsg & sLine & chr(13)</paragraph> +<paragraph id="par_idm1340574096" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1340572864" role="bascode" localize="false" xml-lang="en-US"> Wend</paragraph> +<paragraph id="par_idm1340571632" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1340570400" role="bascode" localize="false" xml-lang="en-US"> MsgBox sMsg</paragraph> +<paragraph id="par_idm1340569168" 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/03020204.xhp b/helpcontent2/source/text/sbasic/shared/03020204.xhp new file mode 100644 index 000000000..79a276ecd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020204.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="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> + + +<paragraph id="hd_id3150360" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020204.xhp" name="Put Statement">Put Statement</link></paragraph> +<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> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020201.xhp" name="Get"><item type="literal">Get</item></link> statement</paragraph> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">Put [#] FileNumber As Integer, [position], Variable</paragraph> +</bascode> + +<paragraph id="hd_id3153190" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3146120" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</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>Position: </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> + +<paragraph id="hd_id3154491" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341567184" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomAccess</paragraph> +<paragraph id="par_idm1341565952" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_id3154729" role="bascode" xml-lang="en-US">Dim sText As Variant ' Must be a variant type</paragraph> +<paragraph id="par_idm1341562976" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1341561744" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1341560496" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341559264" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Random As #iNumber Len=32</paragraph> +<paragraph id="par_id3156278" role="bascode" xml-lang="en-US"> Seek #iNumber,1 ' Position To start writing</paragraph> +<paragraph id="par_id3153711" role="bascode" xml-lang="en-US"> Put #iNumber,, "This is the first line of text" ' Fill line with text</paragraph> +<paragraph id="par_id3155446" role="bascode" xml-lang="en-US"> Put #iNumber,, "This is the second line of text"</paragraph> +<paragraph id="par_id3154255" role="bascode" xml-lang="en-US"> Put #iNumber,, "This is the third line of text"</paragraph> +<paragraph id="par_idm1341550944" role="bascode" localize="false" xml-lang="en-US"> Seek #iNumber,2</paragraph> +<paragraph id="par_idm1341549712" role="bascode" localize="false" xml-lang="en-US"> Get #iNumber,,sText</paragraph> +<paragraph id="par_idm1341548480" role="bascode" localize="false" xml-lang="en-US"> Print sText</paragraph> +<paragraph id="par_idm1341547248" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341546016" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341544784" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Random As #iNumber Len=32</paragraph> +<paragraph id="par_idm1341543520" role="bascode" localize="false" xml-lang="en-US"> Get #iNumber,2,sText</paragraph> +<paragraph id="par_id3150940" role="bascode" xml-lang="en-US"> Put #iNumber,,"This is new text"</paragraph> +<paragraph id="par_idm1341540544" role="bascode" localize="false" xml-lang="en-US"> Get #iNumber,1,sText</paragraph> +<paragraph id="par_idm1341539296" role="bascode" localize="false" xml-lang="en-US"> Get #iNumber,2,sText</paragraph> +<paragraph id="par_id3159102" role="bascode" xml-lang="en-US"> Put #iNumber,20,"This is the text in record 20"</paragraph> +<paragraph id="par_idm1341536304" role="bascode" localize="false" xml-lang="en-US"> Print Lof(#iNumber)</paragraph> +<paragraph id="par_idm1341535072" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341533840" 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/03020205.xhp b/helpcontent2/source/text/sbasic/shared/03020205.xhp new file mode 100644 index 000000000..e40f57bb7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020205.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="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> + + +<paragraph id="hd_id3147229" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020205.xhp" name="Write Statement">Write Statement</link></paragraph> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Writes data to a sequential file.</paragraph> +</section> + +<paragraph id="hd_id3150449" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3145785" role="bascode" xml-lang="en-US">Write [#FileName], [Expressionlist]<comment>see i61248</comment></paragraph> +</bascode> + +<paragraph id="hd_id3151116" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153728" role="paragraph" xml-lang="en-US"> <emph>FileName:</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" xml-lang="en-US"> <emph>Expressionlist:</emph> Variables or expressions that you want to enter in a file, separated by commas.</paragraph> +<paragraph id="par_id3150010" role="paragraph" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">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" xml-lang="en-US">Each <emph>Write</emph> statement outputs a line end symbol as last entry.</paragraph> +<paragraph id="par_id6618854" role="paragraph" xml-lang="en-US">Numbers with decimal delimiters are converted according to the locale settings.</paragraph> + +<paragraph id="hd_id3151073" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340911536" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWrite</paragraph> +<paragraph id="par_idm1340910304" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph> +<paragraph id="par_idm1340909072" role="bascode" localize="false" xml-lang="en-US">Dim sValue As String</paragraph> +<paragraph id="par_idm1340907840" role="bascode" localize="false" xml-lang="en-US"> iCount = Freefile</paragraph> +<paragraph id="par_idm1340906608" role="bascode" localize="false" xml-lang="en-US"> Open "C:\data.txt" For Output As iCount</paragraph> +<paragraph id="par_idm1340905344" role="bascode" localize="false" xml-lang="en-US"> sValue = "Hamburg"</paragraph> +<paragraph id="par_idm1340904112" role="bascode" localize="false" xml-lang="en-US"> Write #iCount,sValue,200</paragraph> +<paragraph id="par_idm1340902864" role="bascode" localize="false" xml-lang="en-US"> sValue = "New York"</paragraph> +<paragraph id="par_idm1340901632" role="bascode" localize="false" xml-lang="en-US"> Write #iCount,sValue,300</paragraph> +<paragraph id="par_idm1340900384" role="bascode" localize="false" xml-lang="en-US"> sValue = "Miami"</paragraph> +<paragraph id="par_idm1340899152" role="bascode" localize="false" xml-lang="en-US"> Write #iCount,sValue,450</paragraph> +<paragraph id="par_idm1340897904" role="bascode" localize="false" xml-lang="en-US"> Close #iCount</paragraph> +<paragraph id="par_idm1340896672" 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/03020301.xhp b/helpcontent2/source/text/sbasic/shared/03020301.xhp new file mode 100644 index 000000000..b9c84f456 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020301.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="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> + +<paragraph id="hd_id3149119" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147399" role="bascode" xml-lang="en-US">Eof (intexpression As Integer)</paragraph> +</bascode> + +<paragraph id="hd_id3153539" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156027" role="paragraph" xml-lang="en-US">Bool</paragraph> + +<paragraph id="hd_id3152924" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3154046" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341592032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm1341590784" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341589552" role="bascode" localize="false" xml-lang="en-US">Dim sLine As String</paragraph> +<paragraph id="par_idm1341588320" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph id="par_idm1341587088" role="bascode" localize="false" xml-lang="en-US">Dim sMsg As String</paragraph> +<paragraph id="par_idm1341585856" role="bascode" localize="false" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph id="par_idm1341584608" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341583376" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3153360" role="bascode" xml-lang="en-US"> Print #iNumber, "First line of text"</paragraph> +<paragraph id="par_id3148797" role="bascode" xml-lang="en-US"> Print #iNumber, "Another line of text"</paragraph> +<paragraph id="par_idm1341578592" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341577360" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341576128" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1341574880" role="bascode" localize="false" xml-lang="en-US"> While Not eof(iNumber)</paragraph> +<paragraph id="par_idm1341573632" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1341572384" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1341571136" role="bascode" localize="false" xml-lang="en-US"> sMsg = sMsg & sLine & chr(13)</paragraph> +<paragraph id="par_idm1341569872" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341568640" role="bascode" localize="false" xml-lang="en-US"> Wend</paragraph> +<paragraph id="par_idm1341567408" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341566176" role="bascode" localize="false" xml-lang="en-US"> MsgBox sMsg</paragraph> +<paragraph id="par_idm1341564944" 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/03020302.xhp b/helpcontent2/source/text/sbasic/shared/03020302.xhp new file mode 100644 index 000000000..8e93fd5b8 --- /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" 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..a00387724 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020303.xhp @@ -0,0 +1,81 @@ +<?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> +<paragraph role="heading" id="hd_id3153380" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150359" xml-lang="en-US">Lof (FileNumber)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154141" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3147230" xml-lang="en-US">Long</paragraph> +<paragraph role="heading" id="hd_id3156281" xml-lang="en-US" level="2">Parameters:</paragraph> +<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 Open 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 <emph>FileLen</emph> 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"/> +<paragraph role="heading" id="hd_id3155415" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" localize="false" id="par_id3151074" xml-lang="en-US">Sub ExampleRandomAccess</paragraph> +<paragraph role="bascode" localize="false" id="par_id3145251" xml-lang="en-US">Dim iNumber As Integer</paragraph> +<paragraph role="bascode" id="par_id3154730" xml-lang="en-US">Dim sText As Variant REM must be a Variant</paragraph> +<paragraph role="bascode" localize="false" id="par_id3145646" xml-lang="en-US">Dim aFile As String</paragraph> +<paragraph role="bascode" localize="false" id="par_id3153157" xml-lang="en-US"> aFile = "c:\data.txt"</paragraph> +<paragraph role="bascode" localize="false" id="par_id3149403" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph role="bascode" localize="false" id="par_id3149121" xml-lang="en-US"> Open aFile For Random As #iNumber Len=32</paragraph> +<paragraph role="bascode" id="par_id3156276" xml-lang="en-US"> Seek #iNumber,1 REM Position at start</paragraph> +<paragraph role="bascode" id="par_id3148405" xml-lang="en-US"> Put #iNumber,, "This is the first line of text" REM Fill with text</paragraph> +<paragraph role="bascode" id="par_id3154756" xml-lang="en-US"> Put #iNumber,, "This is the second line of text"</paragraph> +<paragraph role="bascode" id="par_id3145643" xml-lang="en-US"> Put #iNumber,, "This is the third line of text"</paragraph> +<paragraph role="bascode" localize="false" id="par_id3156383" xml-lang="en-US"> Seek #iNumber,2</paragraph> +<paragraph role="bascode" localize="false" id="par_id3155333" xml-lang="en-US"> Get #iNumber,,sText</paragraph> +<paragraph role="bascode" localize="false" id="par_id3149255" xml-lang="en-US"> Print sText</paragraph> +<paragraph role="bascode" localize="false" id="par_id3154702" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph role="bascode" localize="false" id="par_id3153965" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph role="bascode" localize="false" id="par_id3163807" xml-lang="en-US"> Open aFile For Random As #iNumber Len=32</paragraph> +<paragraph role="bascode" localize="false" id="par_id3155607" xml-lang="en-US"> Get #iNumber,2,sText</paragraph> +<paragraph role="bascode" id="par_id3150299" xml-lang="en-US"> Put #iNumber,,"This is a new line of text"</paragraph> +<paragraph role="bascode" localize="false" id="par_id3147002" xml-lang="en-US"> Get #iNumber,1,sText</paragraph> +<paragraph role="bascode" localize="false" id="par_id3149036" xml-lang="en-US"> Get #iNumber,2,sText</paragraph> +<paragraph role="bascode" id="par_id3166425" xml-lang="en-US"> Put #iNumber,20,"This is the text in record 20"</paragraph> +<paragraph role="bascode" localize="false" id="par_id3149817" xml-lang="en-US"> Print Lof(#iNumber)</paragraph> +<paragraph role="bascode" localize="false" id="par_id3146811" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph role="bascode" localize="false" id="par_id3154200" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..0d47a77ca --- /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" 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..32424a100 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020305.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="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> +<paragraph role="heading" id="hd_id3159413" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020305.xhp" name="Seek Statement">Seek Statement</link></paragraph> +<paragraph role="paragraph" id="par_id3153381" xml-lang="en-US">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" xml-lang="en-US">For random access files, the Seek statement sets the number of the next record to be accessed.</paragraph> +<paragraph role="paragraph" id="par_id5444807" xml-lang="en-US">For all other files, the Seek statement sets the byte position at which the next operation is to occur.</paragraph> +<paragraph role="paragraph" id="par_id3156280" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link>, <link href="text/sbasic/shared/03020304.xhp" name="Seek">Seek</link>.</paragraph> +<paragraph role="heading" id="hd_id3145785" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145273" xml-lang="en-US">Seek[#FileNumber], Position (As Long)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154321" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3153952" xml-lang="en-US"> +<emph>FileNumber: </emph>The data channel number used in the Open statement.</paragraph> +<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US"> +<emph>Position: </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"/> +</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..eea88c05f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020401.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="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> + + +<paragraph id="hd_id3150178" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020401.xhp" name="ChDir Statement">ChDir Statement</link></paragraph> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US">Changes the current directory or drive.</paragraph> +</section> + +<section id="i30692"> +<paragraph id="par_id9783013" role="warning" xml-lang="en-US">This statement currently does not work as documented. See <link href="https://bz.apache.org/ooo/show_bug.cgi?id=30692">this issue</link> for more information.</paragraph> +</section> + +<paragraph id="hd_id3154347" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153897" role="bascode" xml-lang="en-US">ChDir Text As String</paragraph> +</bascode> + +<paragraph id="hd_id3148664" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3151116" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341266032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleChDir</paragraph> +<paragraph id="par_idm1341264800" role="bascode" localize="false" xml-lang="en-US">Dim sDir1 As String , sDir2 As String</paragraph> +<paragraph id="par_idm1341263552" role="bascode" localize="false" xml-lang="en-US"> sDir1 = "c:\Test"</paragraph> +<paragraph id="par_idm1341262320" role="bascode" localize="false" xml-lang="en-US"> sDir2 = "d:\Private"</paragraph> +<paragraph id="par_idm1341261072" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir1 )</paragraph> +<paragraph id="par_idm1341259840" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341258608" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir2 )</paragraph> +<paragraph id="par_idm1341257376" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341256144" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..21087ed3e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020402.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="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> + + +<paragraph id="hd_id3145068" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020402.xhp" name="ChDrive Statement">ChDrive Statement</link></paragraph> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Changes the current drive.</paragraph> +</section> +<embed href="text/sbasic/shared/03020401.xhp#i30692"/> + +<paragraph id="hd_id3154138" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154685" role="bascode" xml-lang="en-US">ChDrive Text As String</paragraph> +</bascode> + +<paragraph id="hd_id3156423" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3153188" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020403.xhp b/helpcontent2/source/text/sbasic/shared/03020403.xhp new file mode 100644 index 000000000..c238a5d1e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020403.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="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> + + +<paragraph id="hd_id3153126" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020403.xhp">CurDir Function</link></paragraph> +<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns a variant string that represents the current path of the specified drive.</paragraph> +</section> +<embed href="text/sbasic/shared/03020401.xhp#i30692"/> + +<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153381" role="bascode" xml-lang="en-US">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> + +<paragraph id="hd_id3156423" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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).</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 (""), CurDir returns the path for the current drive. $[officename] Basic reports an error if the syntax of the drive description is incorrect, the drive does not exist, or if the drive letter occurs after the letter defined in the CONFIG.SYS with the Lastdrive statement.</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"/> + +<paragraph id="hd_id3155411" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341570656" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCurDir</paragraph> +<paragraph id="par_idm1341569424" role="bascode" localize="false" xml-lang="en-US">Dim sDir1 As String , sDir2 As String</paragraph> +<paragraph id="par_idm1341568176" role="bascode" localize="false" xml-lang="en-US"> sDir1 = "c:\Test"</paragraph> +<paragraph id="par_idm1341566944" role="bascode" localize="false" xml-lang="en-US"> sDir2 = "d:\Private"</paragraph> +<paragraph id="par_idm1341565696" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir1 )</paragraph> +<paragraph id="par_idm1341564464" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341563232" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir2 )</paragraph> +<paragraph id="par_idm1341562000" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341560768" 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/03020404.xhp b/helpcontent2/source/text/sbasic/shared/03020404.xhp new file mode 100644 index 000000000..7a763a9f2 --- /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> + + +<paragraph id="hd_id3154347" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020404.xhp" name="Dir Function">Dir Function</link></paragraph> +<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> + +<paragraph id="hd_id3154365" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3156282" role="bascode" xml-lang="en-US">Dir [(Text As String) [, Attrib As Integer]]</paragraph> +</bascode> + +<paragraph id="hd_id3156424" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3153770" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3154942" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341562192" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">Dim sPath As String</paragraph> +<paragraph id="par_idm1341558000" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US"> sPath = CurDir</paragraph> +<paragraph id="par_idm1341553808" role="bascode" localize="false" xml-lang="en-US"> sValue = Dir$(sPath + getPathSeparator + "*",16)</paragraph> +<paragraph id="par_idm1341552544" role="bascode" localize="false" xml-lang="en-US"> Do</paragraph> +<paragraph id="par_idm1341551312" role="bascode" localize="false" xml-lang="en-US"> If sValue <> "." And sValue <> ".." Then</paragraph> +<paragraph id="par_idm1341550000" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> sDir = sDir & chr(13) & sValue</paragraph> +<paragraph id="par_idm1341545632" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341544400" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341543168" role="bascode" localize="false" xml-lang="en-US"> sValue = Dir$</paragraph> +<paragraph id="par_idm1341541936" role="bascode" localize="false" xml-lang="en-US"> Loop Until sValue = ""</paragraph> +<paragraph id="par_idm1341540688" role="bascode" localize="false" xml-lang="en-US"> MsgBox sDir,0,sPath</paragraph> +<paragraph id="par_idm1341539456" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..09b49a3fa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020405.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="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> + +<paragraph id="hd_id3151116" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154012" role="bascode" xml-lang="en-US">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph> +</bascode> + +<paragraph id="hd_id3147349" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3153728" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3147339" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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:\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> +</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..8e443a6db --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020408.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="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> + +<paragraph id="hd_id3159414" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149656" role="bascode" xml-lang="en-US">FileLen (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3148798" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156282" role="paragraph" xml-lang="en-US">Long</paragraph> + +<paragraph id="hd_id3150768" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 FileLen 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 Lof function.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3163710" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341573440" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileLen</paragraph> +<paragraph id="par_idm1341572208" role="bascode" localize="false" xml-lang="en-US"> MsgBox FileLen("C:\autoexec.bat")</paragraph> +<paragraph id="par_idm1341570960" 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/03020409.xhp b/helpcontent2/source/text/sbasic/shared/03020409.xhp new file mode 100644 index 000000000..cb1bee4d8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020409.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="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> + +<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> + +<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..bba94acb7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020410.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="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> + +<paragraph id="hd_id3150767" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154685" role="bascode" xml-lang="en-US">Kill File As String</paragraph> +</bascode> + +<paragraph id="hd_id3153194" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3148645" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm871806352" role="bascode" localize="false" xml-lang="en-US">Sub ExampleKill</paragraph> +<paragraph id="par_id3163710" role="bascode" xml-lang="en-US"> Kill "C:\datafile.dat" ' File must be created in advance</paragraph> +<paragraph id="par_idm871803312" 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/03020411.xhp b/helpcontent2/source/text/sbasic/shared/03020411.xhp new file mode 100644 index 000000000..a13781fa7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020411.xhp @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3156421" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020411.xhp" name="MkDir Statement">MkDir Statement</link></paragraph> +<paragraph id="par_id3147000" role="paragraph" xml-lang="en-US">Creates a new directory on a data medium.</paragraph> +</section> + +<paragraph id="hd_id3148520" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155150" role="bascode" xml-lang="en-US">MkDir Text As String</paragraph> +</bascode> + +<paragraph id="hd_id3156027" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153750" role="paragraph" xml-lang="en-US"> <emph>Text:</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"/> + +<paragraph id="hd_id3155388" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341385136" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">Const sFile1 As String = "file://c|/autoexec.bat"</paragraph> +<paragraph id="par_idm1341380848" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">Dim sFile As String</paragraph> +<paragraph id="par_idm1341373168" role="bascode" localize="false" xml-lang="en-US"> sFile = sDir1 + "/" + sSubDir1</paragraph> +<paragraph id="par_idm1341371920" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> 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" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341364672" role="bascode" localize="false" xml-lang="en-US"> sFile = sFile + "/" + sFile2</paragraph> +<paragraph id="par_idm1341363424" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> 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" xml-lang="en-US"> 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" xml-lang="en-US"> Kill sFile</paragraph> +<paragraph id="par_idm1341345760" role="bascode" localize="false" xml-lang="en-US"> RmDir sDir1 + "/" + sSubDir1</paragraph> +<paragraph id="par_idm1341344512" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_id3153157" role="bascode" localize="false" xml-lang="en-US"> </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" xml-lang="en-US">Function fSysURL( fSysFp As String ) As String</paragraph> +<paragraph id="par_idm1341099040" role="bascode" localize="false" xml-lang="en-US">Dim iPos As String</paragraph> +<paragraph id="par_idm1341097808" role="bascode" localize="false" xml-lang="en-US"> iPos = 1</paragraph> +<paragraph id="par_idm1341096576" role="bascode" localize="false" xml-lang="en-US"> iPos = Instr(iPos,fSysFp, getPathSeparator())</paragraph> +<paragraph id="par_idm1341095312" role="bascode" localize="false" xml-lang="en-US"> Do While iPos > 0</paragraph> +<paragraph id="par_idm1341093984" role="bascode" localize="false" xml-lang="en-US"> Mid( fSysFp, iPos , 1,"/")</paragraph> +<paragraph id="par_idm1341092768" role="bascode" localize="false" xml-lang="en-US"> iPos = Instr(iPos+1,fSysFp, getPathSeparator())</paragraph> +<paragraph id="par_idm1341091504" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> iPos = Instr(1,fSysFp,":")</paragraph> +<paragraph id="par_idm1341087296" role="bascode" localize="false" xml-lang="en-US"> If iPos > 0 Then Mid( fSysFp, iPos , 1,"|")</paragraph> +<paragraph id="par_idm1341085952" role="bascode" localize="false" xml-lang="en-US"> fSysURL = "file://" & fSysFp</paragraph> +<paragraph id="par_idm1341084688" role="bascode" localize="false" xml-lang="en-US">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..6ad7aed81 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020413.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="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> + + +<paragraph id="hd_id3148947" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020413.xhp" name="RmDir Statement">RmDir Statement</link></paragraph> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US">Deletes an existing directory from a data medium.</paragraph> +</section> + +<paragraph id="hd_id3153361" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154367" role="bascode" xml-lang="en-US">RmDir Text As String</paragraph> +</bascode> + +<paragraph id="hd_id3156281" 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 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"/> + +<paragraph id="hd_id3145271" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..318f48925 --- /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="datumzeit"> + <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#datumswerte"/> + <embed href="text/sbasic/shared/03030200.xhp#uhrzeiten"/> + <embed href="text/sbasic/shared/03030300.xhp#ermitteln"/> + </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..4ef4ed9e7 --- /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="datumswerte"> +<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..a313f6731 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030101.xhp @@ -0,0 +1,70 @@ +<?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> +<paragraph role="heading" id="hd_id3157896" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030101.xhp" name="DateSerial Function">DateSerial Function</link></paragraph> +<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> +<paragraph role="heading" id="hd_id3147264" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3149670" xml-lang="en-US">DateSerial (year, month, day)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150792" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3150398" xml-lang="en-US">Date</paragraph> +<paragraph role="heading" id="hd_id3154141" xml-lang="en-US" level="2">Parameters:</paragraph> +<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"/> +<paragraph role="heading" id="hd_id3155411" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3148646" xml-lang="en-US" localize="false">Sub ExampleDateSerial</paragraph> +<paragraph role="bascode" id="par_id3156441" xml-lang="en-US" localize="false">Dim lDate As Long</paragraph> +<paragraph role="bascode" id="par_id3154791" xml-lang="en-US" localize="false">Dim sDate As String</paragraph> +<paragraph role="bascode" id="par_id3155415" xml-lang="en-US" localize="false"> lDate = DateSerial(1964, 4, 9)</paragraph> +<paragraph role="bascode" id="par_id3147125" xml-lang="en-US" localize="false"> sDate = DateSerial(1964, 4, 9)</paragraph> +<paragraph role="bascode" id="par_id3154942" xml-lang="en-US"> MsgBox lDate ' returns 23476</paragraph> +<paragraph role="bascode" id="par_id3151074" xml-lang="en-US"> MsgBox sDate ' returns 04/09/1964</paragraph> +<paragraph role="bascode" id="par_id3153878" xml-lang="en-US" 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..b8332eba1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030102.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="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> +<paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030102.xhp" name="DateValue Function">DateValue Function</link></paragraph> +<paragraph role="paragraph" id="par_id3150542" xml-lang="en-US">Returns a date value from a date string. The date string is a complete date in a single numeric value. You can also use this serial number to determine the difference between two dates.</paragraph> +</section> +<paragraph role="heading" id="hd_id3148799" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154910" xml-lang="en-US">DateValue [(date)]</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150870" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3153194" xml-lang="en-US">Date<comment>i66764</comment></paragraph> +<paragraph role="heading" id="hd_id3153969" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3153770" xml-lang="en-US"> + <emph>Date:</emph> String expression that contains the date that you want to calculate. In contrast to the DateSerial function that passes years, months and days as separate numeric values, the DateValue function requests the date string to be according to either 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 to ISO date format (momentarily, only the ISO format with hyphens, e.g. "2012-12-31" is accepted).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3153142" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3155412" xml-lang="en-US" localize="false">Sub ExampleDateValue</paragraph> +<paragraph role="bascode" id="par_id3153363" xml-lang="en-US" localize="false"> MsgBox DateValue("12/02/2011")</paragraph> +<paragraph role="bascode" id="par_id3149262" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</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..874ee751a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030105.xhp @@ -0,0 +1,73 @@ +<?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"><link href="text/sbasic/shared/03030105.xhp" name="WeekDay Function">WeekDay Function (BASIC)</link></h1> +<paragraph role="paragraph" id="par_id3146795" xml-lang="en-US">Returns the number corresponding to the weekday represented by a serial date number that is generated by the DateSerial or the DateValue function.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3149655" xml-lang="en-US">WeekDay (Number)</paragraph> +</bascode> +<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#functparameters"/> +<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US"> +<emph>Number:</emph> Integer expression that contains the serial date number that is used to calculate the day of the week (1-7).</paragraph> +<paragraph role="paragraph" id="par_id3159254" xml-lang="en-US">The following example determines the day of the week using the WeekDay function when you enter a 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" id="par_id3145749" xml-lang="en-US" localize="false">Sub ExampleWeekDay</paragraph> +<paragraph role="bascode" id="par_id3147426" xml-lang="en-US" localize="false">Dim sDay As String</paragraph> +<paragraph role="bascode" id="par_id3148576" xml-lang="en-US">' Return And display the day of the week</paragraph> +<paragraph role="bascode" id="par_id3155412" xml-lang="en-US" localize="false"> Select Case WeekDay( Now )</paragraph> +<paragraph role="bascode" id="par_id3155306" xml-lang="en-US" localize="false"> Case 1</paragraph> +<paragraph role="bascode" id="par_id3151117" xml-lang="en-US"> sDay="Sunday"</paragraph> +<paragraph role="bascode" id="par_id3152460" xml-lang="en-US" localize="false"> Case 2</paragraph> +<paragraph role="bascode" id="par_id3153952" xml-lang="en-US"> sDay="Monday"</paragraph> +<paragraph role="bascode" id="par_id3149666" xml-lang="en-US" localize="false"> Case 3</paragraph> +<paragraph role="bascode" id="par_id3153157" xml-lang="en-US"> sDay="Tuesday"</paragraph> +<paragraph role="bascode" id="par_id3154730" xml-lang="en-US" localize="false"> Case 4</paragraph> +<paragraph role="bascode" id="par_id3154942" xml-lang="en-US"> sDay="Wednesday"</paragraph> +<paragraph role="bascode" id="par_id3145799" xml-lang="en-US" localize="false"> Case 5</paragraph> +<paragraph role="bascode" id="par_id3155416" xml-lang="en-US"> sDay="Thursday"</paragraph> +<paragraph role="bascode" id="par_id3150716" xml-lang="en-US" localize="false"> Case 6</paragraph> +<paragraph role="bascode" id="par_id3154015" xml-lang="en-US"> sDay="Friday"</paragraph> +<paragraph role="bascode" id="par_id3146971" xml-lang="en-US" localize="false"> Case 7</paragraph> +<paragraph role="bascode" id="par_id3153707" xml-lang="en-US"> sDay="Saturday"</paragraph> +<paragraph role="bascode" id="par_id3155065" xml-lang="en-US" localize="false"> End Select</paragraph> +<paragraph role="bascode" id="par_id3148993" xml-lang="en-US"> MsgBox "" + sDay,64,"Today Is"</paragraph> +<paragraph role="bascode" id="par_id3149019" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</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..9fb32487b --- /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> + + +<paragraph id="par_idN10548" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030110.xhp">DateAdd Function</link></paragraph> +<paragraph id="par_idN10558" role="paragraph" xml-lang="en-US">Adds a date interval to a given date a number of times and returns the resulting date.</paragraph> +</section> + +<paragraph id="par_idN1055B" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_idN1055F" role="bascode" xml-lang="en-US">DateAdd (Add, Count, Date)</paragraph> +</bascode> + +<paragraph id="par_idN1061E" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_idN10622" role="paragraph" xml-lang="en-US">A Variant containing a date.</paragraph> + +<paragraph id="par_idN10625" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> + <paragraph id="par_idN10629" role="paragraph" xml-lang="en-US"><emph>Add</emph> - A string expression from the following table, specifying the date interval.</paragraph> + +<section id="datetable"> + +<table id="tbl_id7568285"> + <tablerow> + <tablecell> + <paragraph id="par_idN10636" role="tablehead" xml-lang="en-US">Add (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>Count</emph> - A numerical expression specifying how often the Add interval will be added (Count is positive) or subtracted (Count is 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 Add value will be added Count times to this value.</paragraph> + +<paragraph id="par_idN106C7" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340825424" role="bascode" localize="false" xml-lang="en-US">Sub example_dateadd</paragraph> +<paragraph id="par_idm1340824192" role="bascode" localize="false" xml-lang="en-US"> MsgBox DateAdd("m", 1, "1/31/2004") &" - "& DateAdd("m", 1, "1/31/2005")</paragraph> +<paragraph id="par_idm1340822896" 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/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..1cce523c5 --- /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" role="bascode" xml-lang="en-US">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..fdcbbcc61 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030120.xhp @@ -0,0 +1,187 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="par_idN10542" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030120.xhp">DateDiff Function</link></paragraph> +<paragraph id="par_idN10546" role="paragraph" xml-lang="en-US">Returns the number of date intervals between two given date values.</paragraph> +</section> + +<paragraph id="par_idN10549" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_idN10648" role="bascode" xml-lang="en-US">DateDiff (Add, Date1, Date2 [, Week_start [, Year_start]])</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> + +<paragraph id="par_idN10652" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_idN10656" role="paragraph" xml-lang="en-US"> <emph>Add</emph> - A string expression from the following table, specifying the date 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> + +<section id="weekyear"> +<paragraph id="par_idN1066A" role="paragraph" xml-lang="en-US"> <emph>Week_start</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">Week_start 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>Year_start</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">Year_start 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> + +<paragraph id="par_idN10738" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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", "12/31/2005")</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..69beffd4b --- /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> + + +<paragraph id="par_idN10542" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030130.xhp">DatePart Function</link></paragraph> +<paragraph id="par_idN10546" role="paragraph" xml-lang="en-US">The DatePart function returns a specified part of a date.</paragraph> +</section> + +<paragraph id="par_idN10549" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_idN105E8" role="bascode" xml-lang="en-US">DatePart (Add, Date [, Week_start [, Year_start]])</paragraph> +</bascode> + +<paragraph id="par_idN105EB" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_idN105EF" role="paragraph" xml-lang="en-US">A Variant containing a date.</paragraph> + +<paragraph id="par_idN105F2" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_idN105F6" role="paragraph" xml-lang="en-US"> <emph>Add</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/03030120.xhp#weekyear"/> + +<paragraph id="par_idN10611" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341577504" role="bascode" localize="false" xml-lang="en-US">Sub example_datepart</paragraph> +<paragraph id="par_idm1341576272" role="bascode" localize="false" xml-lang="en-US"> MsgBox DatePart("ww", "12/31/2005")</paragraph> +<paragraph id="par_idm1341575024" 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/03030200.xhp b/helpcontent2/source/text/sbasic/shared/03030200.xhp new file mode 100644 index 000000000..4bdce6292 --- /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="uhrzeiten"> + <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..ebda5e11c --- /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 xml-lang="en-US" id="par_id3163798" 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 xml-lang="en-US" id="par_id3146985" role="bascode">Sub ExampleHour</paragraph> + <paragraph xml-lang="en-US" id="par_id3156441" role="bascode">Print "The current hour is " & Hour( Now )</paragraph> + <paragraph xml-lang="en-US" id="par_id3153145" role="bascode" localize="false">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..d4ab9d51f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030202.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="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> +<paragraph xml-lang="en-US" id="hd_id3155419" role="heading" level="1"><link href="text/sbasic/shared/03030202.xhp" name="Minute Function">Minute Function</link></paragraph> + <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> + <paragraph xml-lang="en-US" id="hd_id3154758" role="heading" level="2">Syntax:</paragraph> + <bascode> +<paragraph xml-lang="en-US" id="par_id3149656" role="bascode">Minute (Number)</paragraph> +</bascode> + <paragraph xml-lang="en-US" id="hd_id3148798" role="heading" level="2">Return value:</paragraph> + <paragraph xml-lang="en-US" id="par_id3150449" role="paragraph">Integer</paragraph> + <paragraph xml-lang="en-US" id="hd_id3153193" role="heading" level="2">Parameters:</paragraph> + <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> + <paragraph xml-lang="en-US" id="par_id3149262" role="paragraph">Print Minute(TimeSerial(12,30,41))</paragraph> + <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"/> + <paragraph xml-lang="en-US" id="hd_id3150010" role="heading" level="2">Example:</paragraph> + <bascode> + <paragraph xml-lang="en-US" id="par_id3159154" role="bascode">Sub ExampleMinute</paragraph> + <paragraph xml-lang="en-US" id="par_id3146119" role="bascode">MsgBox "The current minute is "& Minute(Now)& "."</paragraph> + <paragraph xml-lang="en-US" id="par_id3153726" role="bascode" localize="false">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..938032c74 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030203.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="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> + +<paragraph id="hd_id3149416" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030203.xhp" name="Now Function">Now Function</link></paragraph> +<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> + +<paragraph id="hd_id3149456" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149655" role="bascode" localize="false" xml-lang="en-US">Now</paragraph> +</bascode> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3147229" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..77d6bf906 --- /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" role="paragraph" xml-lang="en-US">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..6c79c4ea2 --- /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="ermitteln"> + <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..240e94954 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030301.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="textsbasicshared03030301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Date Statement</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 statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030301.xhp" name="Date Statement">Date Statement</link></paragraph> +<paragraph id="par_id3147291" role="paragraph" xml-lang="en-US">Returns the current system date as a string, or resets the date. The date format depends on your local system settings.</paragraph> +</section> + +<paragraph id="hd_id3148686" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3146794" role="bascode" xml-lang="en-US">Date ; Date = Text As String</paragraph> +</bascode> + +<paragraph id="hd_id3154347" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Only required in order to reset the system date. In this case, the string expression must correspond to the date format defined in your local settings.</paragraph> + +<paragraph id="hd_id3150793" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341306160" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">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..eb45700fa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030302.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="textsbasicshared03030302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Time Statement</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 statement</bookmark_value> +</bookmark> + +<paragraph id="hd_id3145090" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030302.xhp">Time Statement</link></paragraph> +<paragraph id="par_id3150984" role="paragraph" xml-lang="en-US">This function returns the current system time as a string in the format "HH:MM:SS".</paragraph> +</section> + +<paragraph id="hd_id3154346" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149670" role="bascode" localize="false" xml-lang="en-US">Time</paragraph> +</bascode> + +<paragraph id="hd_id3150792" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the new time in the format "HH:MM:SS".</paragraph> + +<paragraph id="hd_id3145173" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341324032" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">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..08cefe05b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030303.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="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> + +<paragraph id="hd_id3149346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030303.xhp" name="Timer Function">Timer Function</link></paragraph> +<paragraph id="par_id3156023" role="paragraph" xml-lang="en-US">Returns a value that specifies the number of seconds that have elapsed since midnight.</paragraph> +</section> +<paragraph id="par_id3156212" role="note" xml-lang="en-US">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> + +<paragraph id="hd_id3153768" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3161831" role="bascode" localize="false" xml-lang="en-US">Timer</paragraph> +</bascode> + +<paragraph id="hd_id3146975" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3146984" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3156442" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341580128" role="bascode" localize="false" xml-lang="en-US">Sub ExampleTimer</paragraph> +<paragraph id="par_idm1341578896" role="bascode" localize="false" xml-lang="en-US">Dim lSec As Long,lMin As Long,lHour As Long</paragraph> +<paragraph id="par_idm1341577632" role="bascode" localize="false" xml-lang="en-US"> lSec = Timer</paragraph> +<paragraph id="par_id3145748" role="bascode" xml-lang="en-US"> MsgBox lSec,0,"Seconds since midnight"</paragraph> +<paragraph id="par_idm1341574656" role="bascode" localize="false" xml-lang="en-US"> lMin = lSec / 60</paragraph> +<paragraph id="par_idm1341573424" role="bascode" localize="false" xml-lang="en-US"> lSec = lSec Mod 60</paragraph> +<paragraph id="par_idm1341572192" role="bascode" localize="false" xml-lang="en-US"> lHour = lMin / 60</paragraph> +<paragraph id="par_idm1341570960" role="bascode" localize="false" xml-lang="en-US"> lMin = lMin Mod 60</paragraph> +<paragraph id="par_id3156283" role="bascode" xml-lang="en-US"> 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" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..0bcdb47e9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03040000.xhp @@ -0,0 +1,356 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + <paragraph id="hd_id051620171022255424" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03040000.xhp">Basic Constants</link></paragraph> + <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">True</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">False</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">Pi</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">Empty</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">Null</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">Nothing</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" localize="false"> 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" localize="false"> Print oDoc ‘ Error</paragraph> + <paragraph id="par_id051720170824103527" role="bascode" localize="false">End Sub</paragraph> + </bascode> + </section> + <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"/> + <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..3c72c3ebf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050000.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="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="fehlerbehan"> + <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"/> +</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..2481ea1cf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050500.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="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> + +<paragraph id="hd_id3151212" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<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> + +<paragraph id="hd_id3154125" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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> + +<paragraph id="hd_id3146985" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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:\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"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03060000.xhp b/helpcontent2/source/text/sbasic/shared/03060000.xhp new file mode 100644 index 000000000..18b196b22 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060000.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="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"> + <paragraph id="hd_id3147559" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060000.xhp" name="Logical Operators">Logical Operators</link></paragraph> + <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"/> + </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..ecf4df3bd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070000.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="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="mathe"> + <paragraph id="hd_id3149234" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070000.xhp" name="Mathematical Operators">Mathematical Operators</link></paragraph> + <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#subtraktion"/> + <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/03070500.xhp#potenz"/> + <embed href="text/sbasic/shared/03070600.xhp#mod"/> + </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..f2d94d433 --- /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="subtraktion"> +<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..798cf06c2 --- /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="potenz"> +<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..42516188e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070600.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="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> + + +<paragraph id="hd_id3150669" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070600.xhp" name="Mod Operator">Mod Operator</link></paragraph> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">Returns the integer remainder of a division.</paragraph> +</section> + +<paragraph id="hd_id3146795" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147560" role="bascode" xml-lang="en-US">Result = Expression1 MOD Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3149657" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153380" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3154365" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145172" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the MOD operation.</paragraph> +<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numeric expressions that you want to divide.</paragraph> + +<paragraph id="hd_id3147287" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340853360" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMod</paragraph> +<paragraph id="par_id3161832" role="bascode" xml-lang="en-US"> Print 10 Mod 2.5 ' returns 0</paragraph> +<paragraph id="par_id3146922" role="bascode" xml-lang="en-US"> Print 10 / 2.5 ' returns 4</paragraph> +<paragraph id="par_id3145273" role="bascode" xml-lang="en-US"> Print 10 Mod 5 ' returns 0</paragraph> +<paragraph id="par_id3150011" role="bascode" xml-lang="en-US"> Print 10 / 5 ' returns 2</paragraph> +<paragraph id="par_id3149483" role="bascode" xml-lang="en-US"> Print 5 Mod 10 ' returns 5</paragraph> +<paragraph id="par_id3151114" role="bascode" xml-lang="en-US"> Print 5 / 10 ' returns 0.5</paragraph> +<paragraph id="par_idm1340841712" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080000.xhp b/helpcontent2/source/text/sbasic/shared/03080000.xhp new file mode 100644 index 000000000..38e89ffa8 --- /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="nummer"> + <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#zufall"/> + <embed href="text/sbasic/shared/03080400.xhp#quadrat"/> + <embed href="text/sbasic/shared/03080500.xhp#ganzzahl"/> + <embed href="text/sbasic/shared/03080600.xhp#absolut"/> + <embed href="text/sbasic/shared/03080700.xhp#vorzeichen"/> + <embed href="text/sbasic/shared/03080800.xhp#umwandeln"/> + </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..af0a6db97 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080101.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="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> + <paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080101.xhp" name="Atn Function">Atn Function</link></paragraph> + <paragraph id="par_id3149346" role="paragraph" xml-lang="en-US">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 Atn 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">Atn(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)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150359" role="paragraph" xml-lang="en-US">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 Atn 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">Pi is here the fixed circle constant with the rounded value 3.14159. Pi 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> +</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..908daeec3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080102.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="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> + + +<paragraph id="hd_id3154923" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080102.xhp" name="Cos Function">Cos Function</link></paragraph> +<paragraph id="par_id3159413" role="paragraph" xml-lang="en-US">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 Cos-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">Cos(Alpha) = Adjacent/Hypotenuse</paragraph> + +<paragraph id="hd_id3154125" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3145172" role="bascode" xml-lang="en-US">Cos (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150449" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3153969" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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">Pi 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"/> + +<paragraph id="hd_id3153951" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..bc3a81c2b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080103.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="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> + + +<paragraph id="hd_id3153896" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080103.xhp" name="Sin Function">Sin Function</link></paragraph> +<paragraph id="par_id3149456" role="paragraph" xml-lang="en-US">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 Sin 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">Sin(Alpha) = side opposite the angle/hypotenuse</paragraph> + +<paragraph id="hd_id3147230" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154909" role="bascode" xml-lang="en-US">Sin (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3155132" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 Pi/180, and to convert radians to degrees, multiply radians by 180/Pi.</paragraph> +<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">grad=(radiant*180)/pi</paragraph> +<paragraph id="par_id3153143" role="paragraph" xml-lang="en-US">radiant=(grad*pi)/180</paragraph> +<paragraph id="par_id3151112" role="paragraph" xml-lang="en-US">Pi is approximately 3.141593.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3163712" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..2fe6d7159 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080104.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="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> + + +<paragraph id="hd_id3148550" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080104.xhp" name="Tan Function">Tan Function</link></paragraph> +<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 Tan 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">Tan(Alpha) = side opposite the angle/side adjacent to angle</paragraph> + +<paragraph id="hd_id3145174" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3151042" role="bascode" xml-lang="en-US">Tan (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156214" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3155132" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 Pi/180. To convert radians to degrees, multiply by 180/Pi.</paragraph> +<paragraph id="par_id3155414" role="paragraph" xml-lang="en-US">degrees=(radiant*180)/Pi</paragraph> +<paragraph id="par_id3146975" role="paragraph" xml-lang="en-US">radiant=(degrees*Pi)/180</paragraph> +<paragraph id="par_id3147434" role="paragraph" xml-lang="en-US">Pi is approximately 3.141593.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149483" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..9847e8af7 --- /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" role="paragraph" xml-lang="en-US">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..3d8c819d3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080202.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="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> + + +<paragraph id="hd_id3149416" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080202.xhp" name="Log Function">Log Function</link></paragraph> +<paragraph id="par_id3145066" role="paragraph" xml-lang="en-US">Returns the natural logarithm of a number.</paragraph> +</section> + +<paragraph id="hd_id3159414" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154760" role="bascode" xml-lang="en-US">Log (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 n(x) = Log(x) / Log(n)</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_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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080300.xhp b/helpcontent2/source/text/sbasic/shared/03080300.xhp new file mode 100644 index 000000000..0bc433da5 --- /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="zufall"> + <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..e898be390 --- /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" role="paragraph" xml-lang="en-US">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..3a8aef25b --- /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="quadrat"> + <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..229edef58 --- /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" role="paragraph" xml-lang="en-US">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..06efe78a2 --- /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="ganzzahl"> + <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..97e9ee82f --- /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" role="paragraph" xml-lang="en-US">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..61ad8390c --- /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" role="paragraph" xml-lang="en-US">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..416e2964d --- /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="absolut"> + <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..39aa93be1 --- /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" role="paragraph" xml-lang="en-US">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..789135e9b --- /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="vorzeichen"> + <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..d96fdd1f6 --- /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" role="paragraph" xml-lang="en-US">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">NumExpression</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..cfb91e92c --- /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="umwandeln"> + <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..410059905 --- /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="programmablauf"> + <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#entscheidung"/> + <embed href="text/sbasic/shared/03090200.xhp#schleifen"/> + <embed href="text/sbasic/shared/03090300.xhp#sprung"/> + <embed href="text/sbasic/shared/03090400.xhp#weitere"/> + </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..a27d2a66c --- /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="entscheidung"> + <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..71832b815 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090101.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="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> + + +<paragraph id="hd_id3154422" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090101.xhp" name="If...Then...Else Statement">If...Then...Else Statement</link></paragraph> +<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 is True.</paragraph> +</section> + +<paragraph id="hd_id3146957" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153126" role="bascode" xml-lang="en-US">If condition=true Then Statement block [ElseIf condition=true Then] Statement block [Else] Statement block EndIf</paragraph> +</bascode> +<paragraph id="par_id3123476" role="paragraph" xml-lang="en-US">Instead of Else If you can write ElseIf, instead of End If you can write EndIf.</paragraph> + +<paragraph id="hd_id3155419" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153062" role="paragraph" xml-lang="en-US">The <emph>If...Then</emph> statement executes program blocks depending on given conditions. When $[officename] Basic encounters an <emph>If</emph> statement, the condition is tested. If the condition is True, all subsequent statements up to the next <emph>Else</emph> or <emph>ElseIf</emph> statement are executed. If the condition is False, and an <emph>ElseIf</emph> statement follows, $[officename] Basic tests the next condition and executes the following statements if the condition is True. If False, 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 True. 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> +<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> + +<paragraph id="hd_id3152576" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341422592" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIfThenDate</paragraph> +<paragraph id="par_idm1341421360" role="bascode" localize="false" xml-lang="en-US">Dim sDate As String</paragraph> +<paragraph id="par_idm1341420128" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US"> sDate = Right$(sDate, 4) + Mid$(sDate, 4, 2) + Left$(sDate, 2)</paragraph> +<paragraph id="par_idm1341415856" role="bascode" localize="false" xml-lang="en-US"> sToday = Date$</paragraph> +<paragraph id="par_idm1341414624" role="bascode" localize="false" xml-lang="en-US"> sToday = Right$(sToday, 4)+ Mid$(sToday, 4, 2) + Left$(sToday, 2)</paragraph> +<paragraph id="par_idm1341413344" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> 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" xml-lang="en-US"> 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" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341403104" 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/03090102.xhp b/helpcontent2/source/text/sbasic/shared/03090102.xhp new file mode 100644 index 000000000..7d9eb53cc --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090102.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="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> + + +<paragraph id="hd_id3149416" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090102.xhp" name="Select...Case Statement">Select...Case Statement</link></paragraph> +<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 id="par_id3150400" role="bascode" xml-lang="en-US">Select Case condition Case expression Statement Block [Case expression2 Statement Block][Case Else] Statement Block End Select</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US"> <emph>condition:</emph> Any expression that controls if the statement block that follows the respective Case clause is executed.</paragraph> + <paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>expression:</emph> Any expression that is compatible with the condition type expression. The statement block that follows the <literal>Case</literal> clause is executed if <emph>condition</emph> matches <emph>expression</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> +</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..8b53d87dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090103.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="textsbasicshared03090103xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">IIf Statement</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 statement</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3155420" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03090103.xhp" name="IIf Statement">IIf Statement</link></paragraph> +<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> +<paragraph role="heading" id="hd_id3159413" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3147560" xml-lang="en-US">IIf (Expression, ExpressionTrue, ExpressionFalse)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150541" xml-lang="en-US" level="2">Parameters:</paragraph> +<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> +<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/03090200.xhp b/helpcontent2/source/text/sbasic/shared/03090200.xhp new file mode 100644 index 000000000..4f91a4715 --- /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="schleifen"> + <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..9606ac66b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090201.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="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 Do and the Loop statement while the condition is True or until the condition becomes True.</paragraph> +</section> + +<paragraph id="hd_id3149119" role="heading" level="2" xml-lang="en-US">Syntax</paragraph> +<paragraph id="par_id3155150" role="bascode" xml-lang="en-US">Do [{While | Until} condition = True]</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">statement block</paragraph> +<paragraph id="par_id3150789" role="bascode" xml-lang="en-US">[Exit Do]</paragraph> +<paragraph id="par_id3155805" role="paragraph" xml-lang="en-US">statement block</paragraph> +<paragraph id="par_id3145090" role="bascode" xml-lang="en-US">Loop</paragraph> +<paragraph id="par_id3154749" role="paragraph" xml-lang="en-US">or</paragraph> +<paragraph id="par_id3150503" role="bascode" xml-lang="en-US">Do</paragraph> +<paragraph id="par_id3149762" role="paragraph" xml-lang="en-US">statement block</paragraph> +<paragraph id="par_id3150984" role="bascode" xml-lang="en-US">[Exit Do]</paragraph> +<paragraph id="par_id3143228" role="paragraph" xml-lang="en-US">statement block</paragraph> +<paragraph id="par_id3149235" role="bascode" xml-lang="en-US">Loop [{While | Until} condition = True]</paragraph> + +<paragraph id="hd_id3156024" role="heading" level="2" xml-lang="en-US">Parameters/Elements</paragraph> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US"> <emph>Condition:</emph> A comparison, numeric or string expression, that evaluates either True or False.</paragraph> +<paragraph id="par_id3149669" role="paragraph" xml-lang="en-US"> <emph>Statement block:</emph> Statements that you want to repeat while or until the condition is True.</paragraph> +<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 True. The condition for exiting the loop must be entered following either the <emph>Do</emph> or the <emph>Loop</emph> statement. The following examples are valid combinations:</paragraph> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Syntax</paragraph> +<paragraph id="par_id3145171" role="bascode" xml-lang="en-US">Do While condition = True</paragraph> +<paragraph id="par_id3149203" role="paragraph" xml-lang="en-US">...statement block</paragraph> +<paragraph id="par_id3125864" role="bascode" xml-lang="en-US">Loop</paragraph> +<paragraph id="par_id3154124" role="paragraph" xml-lang="en-US">The statement block between the Do While and the Loop statements is repeated so long as the condition is true.</paragraph> +<paragraph id="par_id3153968" role="bascode" xml-lang="en-US">Do Until condition = True</paragraph> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">...statement block</paragraph> +<paragraph id="par_id3159151" role="bascode" xml-lang="en-US">Loop</paragraph> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US">The statement block between the Do Until and the Loop statements is repeated if the condition so long as the condition is false.</paragraph> +<paragraph id="par_id3153952" role="bascode" xml-lang="en-US">Do</paragraph> +<paragraph id="par_id3147349" role="paragraph" xml-lang="en-US">...statement block</paragraph> +<paragraph id="par_id3159153" role="bascode" xml-lang="en-US">Loop While condition = True</paragraph> +<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">The statement block between the Do and the Loop statements repeats so long as the condition is true.</paragraph> +<paragraph id="par_id3150488" role="bascode" xml-lang="en-US">Do</paragraph> +<paragraph id="par_id3153189" role="paragraph" xml-lang="en-US">...statement block</paragraph> +<paragraph id="par_id3155411" role="bascode" xml-lang="en-US">Loop Until condition = True</paragraph> +<paragraph id="par_id3151117" role="paragraph" xml-lang="en-US">The statement block between the Do and the Loop statements repeats until the condition is true.</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> +<paragraph id="par_id3149262" role="bascode" xml-lang="en-US">Do...</paragraph> +<paragraph id="par_id3149298" role="paragraph" xml-lang="en-US">statements</paragraph> +<paragraph id="par_id3145646" role="bascode" xml-lang="en-US">If condition = True Then Exit Do</paragraph> +<paragraph id="par_id3154490" role="paragraph" xml-lang="en-US">statements</paragraph> +<paragraph id="par_id3153159" role="bascode" xml-lang="en-US">Loop...</paragraph> + +<paragraph id="hd_id3147396" role="heading" level="2" xml-lang="en-US">Example</paragraph> +<bascode> +<paragraph id="par_idm1341080208" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDoLoop</paragraph> +<paragraph id="par_idm1341078976" role="bascode" localize="false" xml-lang="en-US">Dim sFile As String</paragraph> +<paragraph id="par_idm1341077744" role="bascode" localize="false" xml-lang="en-US">Dim sPath As String</paragraph> +<paragraph id="par_idm1341076512" role="bascode" localize="false" xml-lang="en-US"> sPath = "c:\"</paragraph> +<paragraph id="par_idm1341075280" role="bascode" localize="false" xml-lang="en-US"> sFile = Dir$( sPath ,22)</paragraph> +<paragraph id="par_idm1341074032" role="bascode" localize="false" xml-lang="en-US"> If sFile <> "" Then</paragraph> +<paragraph id="par_idm1341072656" role="bascode" localize="false" xml-lang="en-US"> Do</paragraph> +<paragraph id="par_idm1341071456" role="bascode" localize="false" xml-lang="en-US"> MsgBox sFile</paragraph> +<paragraph id="par_idm1341070208" role="bascode" localize="false" xml-lang="en-US"> sFile = Dir$</paragraph> +<paragraph id="par_idm1341068960" role="bascode" localize="false" xml-lang="en-US"> Loop Until sFile = ""</paragraph> +<paragraph id="par_idm1341067712" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341066480" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..7fc43cdf4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090202.xhp @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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_value>Step 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..c29905c08 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090203.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="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><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 While statement, it tests the condition. If the condition is False, the program continues directly following the Wend statement. If the condition is True, the loop is executed until the program finds Wend and then jumps back to the<emph> While </emph>statement. If the condition is still True, 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 While...Wend 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 Do...Loop is more flexible than a While...Wend.</paragraph> + <paragraph role="heading" level="2" id="hd_id3155133" xml-lang="en-US">Syntax:</paragraph> + <bascode> +<paragraph role="bascode" id="par_id3147288" xml-lang="en-US">While Condition [Statement] Wend</paragraph> +</bascode> + <paragraph role="heading" level="2" id="hd_id3153139" xml-lang="en-US">Example:</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3159153" xml-lang="en-US">Sub ExampleWhileWend</paragraph> + <paragraph role="bascode" id="par_id3151114" xml-lang="en-US">Dim stext As String</paragraph> + <paragraph role="bascode" id="par_id3153143" xml-lang="en-US">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" xml-lang="en-US"> iRun = 1</paragraph> + <paragraph role="bascode" id="par_id3147215" xml-lang="en-US"> While iRun < Len(sText)</paragraph> + <paragraph role="bascode" id="par_id3147427" xml-lang="en-US"> If Mid(sText,iRun,1 )<> " " Then Mid( sText ,iRun, 1, Chr( 1 + Asc( Mid(sText,iRun,1 )) )</paragraph> + <paragraph role="bascode" id="par_id3149665" xml-lang="en-US"> iRun = iRun + 1</paragraph> + <paragraph role="bascode" id="par_id3152939" xml-lang="en-US"> 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" xml-lang="en-US">End Sub</paragraph> +</bascode> + </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..c0d96aa8d --- /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="sprung"> + <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..720aa3fdc --- /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 in 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 then 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..f86cfeb44 --- /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="weitere"> + <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..662580d96 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090401.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="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> +<paragraph role="heading" id="hd_id3154422" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03090401.xhp" name="Call Statement">Call Statement</link></paragraph> +<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> +<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2">Syntax:</paragraph> +<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> +<paragraph role="heading" id="hd_id3150771" xml-lang="en-US" level="2">Parameters:</paragraph> +<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> +<paragraph role="heading" id="hd_id3125865" xml-lang="en-US" level="2">Example:</paragraph> +<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> +</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..1abbfa6ea --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090402.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="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> + + +<paragraph id="hd_id3143271" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090402.xhp" name="Choose Function">Choose Function</link></paragraph> +<paragraph id="par_id3149234" role="paragraph" xml-lang="en-US">Returns a selected value from a list of arguments.</paragraph> +</section> + +<paragraph id="hd_id3148943" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147560" role="bascode" xml-lang="en-US">Choose (Index, Selection1[, Selection2, ... [,Selection_n]])</paragraph> +</bascode> + +<paragraph id="hd_id3154346" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3148664" role="paragraph" xml-lang="en-US"> <emph>Index:</emph> A numeric expression that specifies the value to return.</paragraph> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US"> <emph>Selection1:</emph> Any expression that contains one 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 Index = 1, the function returns the first expression in the list, if index i= 2, 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 Null value.</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">The following example uses the <emph>Choose</emph> function to select a string from several strings that form a menu:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3150439" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm871799424" role="bascode" localize="false" xml-lang="en-US">Sub ExampleChoose</paragraph> +<paragraph id="par_idm871798192" role="bascode" localize="false" xml-lang="en-US">Dim sReturn As String</paragraph> +<paragraph id="par_idm871796960" role="bascode" localize="false" xml-lang="en-US"> sReturn = ChooseMenu(2)</paragraph> +<paragraph id="par_idm871795712" role="bascode" localize="false" xml-lang="en-US"> Print sReturn</paragraph> +<paragraph id="par_idm871794480" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm871793248" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm871792000" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US">End Function</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file 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..eb10a54c3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090406.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="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> + +<paragraph id="hd_id3153346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090406.xhp" name="Function Statement">Function Statement</link></paragraph> +<paragraph id="par_id3159158" role="paragraph" xml-lang="en-US">Defines a subroutine that can be used as an expression to determine a return type.</paragraph> +</section> + +<section id="TwinMethods"> +<note id="par_id661588586825434"><literal>Sub</literal> or <literal>Function</literal> statements are similar methods, without distinction. They receive parameters by reference allowing them to be modified. %PRODUCTNAME Basic compiler accepts their respective syntax to be used interchangeably.</note> +</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" xml-lang="en-US">Sub ExampleExit</paragraph> +<paragraph id="par_idm1340980496" role="bascode" localize="false" xml-lang="en-US">Dim sReturn As String</paragraph> +<paragraph id="par_idm1340979264" role="bascode" localize="false" xml-lang="en-US">Dim sListArray(10) As String</paragraph> +<paragraph id="par_idm1340978016" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US"> sListArray(siStep) = chr$(siStep + 65)</paragraph> +<paragraph id="par_idm1340973776" role="bascode" localize="false" xml-lang="en-US"> MsgBox sListArray(siStep)</paragraph> +<paragraph id="par_idm1340972528" role="bascode" localize="false" xml-lang="en-US"> Next siStep</paragraph> +<paragraph id="par_idm1340971296" role="bascode" localize="false" xml-lang="en-US"> sReturn = LinSearch(sListArray(), "B")</paragraph> +<paragraph id="par_idm1340970032" role="bascode" localize="false" xml-lang="en-US"> Print sReturn</paragraph> +<paragraph id="par_idm1340968800" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340967568" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340966320" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US"> For iCount=1 To Ubound( sList() )</paragraph> +<paragraph id="par_idm1340959056" role="bascode" localize="false" xml-lang="en-US"> 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" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1340954848" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_idm1340953616" role="bascode" localize="false" xml-lang="en-US"> If iCount = Ubound( sList() ) Then iCount = 0</paragraph> +<paragraph id="par_idm1340952352" role="bascode" localize="false" xml-lang="en-US"> LinSearch = iCount</paragraph> +<paragraph id="par_idm1340951120" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> +</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..360c6fbdd --- /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" role="code" xml-lang="en-US">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..d78fa9df0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090408.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="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> + +<paragraph id="hd_id3153311" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090408.xhp" name="Stop Statement">Stop Statement</link></paragraph> +<paragraph id="par_id3154142" role="paragraph" xml-lang="en-US">Stops the execution of the Basic program.</paragraph> +</section> + +<paragraph id="hd_id3153126" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3156023" role="bascode" localize="false" xml-lang="en-US">Stop</paragraph> +</bascode> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341620128" role="bascode" localize="false" xml-lang="en-US">Sub ExampleStop</paragraph> +<paragraph id="par_idm1341618896" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Single</paragraph> +<paragraph id="par_idm1341617664" role="bascode" localize="false" xml-lang="en-US"> iVar = 36</paragraph> +<paragraph id="par_idm1341616432" role="bascode" localize="false" xml-lang="en-US"> Stop</paragraph> +<paragraph id="par_idm1341615200" role="bascode" localize="false" xml-lang="en-US"> MsgBox Sqr(iVar)</paragraph> +<paragraph id="par_idm1341613968" role="bascode" localize="false" xml-lang="en-US">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..9dbe58789 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090409.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="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> + +<paragraph id="hd_id3147226" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090409.xhp" name="Sub Statement">Sub Statement</link></paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">Defines a subroutine.</paragraph> +</section> +<embed href="text/sbasic/shared/03090406.xhp#TwinMethods"/> + +<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"/> + +</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..dc751a7e8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090410.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="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> + + +<paragraph id="hd_id3148554" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090410.xhp" name="Switch Function">Switch Function</link></paragraph> +<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> + +<paragraph id="hd_id3154863" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155934" role="bascode" xml-lang="en-US">Switch (Expression1, Value1[, Expression2, Value2[..., Expression_n, Value_n]])</paragraph> +</bascode> + +<paragraph id="hd_id3149119" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3159157" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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_id3149579" role="bascode" 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> +</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..5d4c41596 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090411.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="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> +<paragraph role="heading" id="hd_id3153311" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03090411.xhp" name="With Statement">With Statement</link></paragraph> +<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 End With statement is reached.</paragraph> +</section> +<paragraph role="heading" id="hd_id3156153" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3145609" xml-lang="en-US" localize="false">With Object</paragraph> + <paragraph role="bascode" id="par_id951512205849777" xml-lang="en-US" localize="false"> Statement block</paragraph> + <paragraph role="bascode" id="par_id841512205903256" xml-lang="en-US" localize="false">End With</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154924" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US">Use <emph>With</emph> and <emph>End With</emph> if you have several properties or methods for a single object.</paragraph> +</body> +</helpdocument> + 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..e7c2329ea --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090413.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="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> + <paragraph role="heading" id="hd_id3153311" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03090413.xhp" name="Type Statement">Type Statement</link></paragraph> + <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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03100000.xhp b/helpcontent2/source/text/sbasic/shared/03100000.xhp new file mode 100644 index 000000000..1c7419748 --- /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="variablen"> +<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..bd4a2b239 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100050.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="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> +<paragraph role="heading" id="par_idN10541" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03100050.xhp">CCur Function</link></paragraph> +<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> +<paragraph role="heading" id="par_idN10548" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_idN105E8" xml-lang="en-US">CCur(Expression)</paragraph> +</bascode> +<paragraph role="heading" id="par_idN105EB" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_idN105EF" xml-lang="en-US">Currency</paragraph> +<paragraph role="heading" id="par_idN105F2" xml-lang="en-US" level="2">Parameter:</paragraph> +<paragraph role="paragraph" id="par_idN105F6" 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/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..e8f2b9ece --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100100.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="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> + + +<paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100100.xhp" name="CBool Function">CBool Function</link></paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US">Converts a string comparison or numeric comparison to a Boolean expression, or converts a single numeric expression to a Boolean expression.</paragraph> +</section> + +<paragraph id="hd_id3153345" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149514" role="bascode" xml-lang="en-US">CBool (Expression1 {= | <> | < | > | <= | >=} Expression2) or CBool (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156152" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Bool</paragraph> + +<paragraph id="hd_id3147530" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any string or numeric expressions that you want to compare. If the expressions match, the <emph>CBool</emph> function returns <emph>True</emph>, otherwise <emph>False</emph> is returned.</paragraph> +<paragraph id="par_id3149655" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to convert. If the expression equals 0, <emph>False</emph> is returned, otherwise <emph>True</emph> is returned.</paragraph> +<paragraph id="par_id3145171" role="paragraph" xml-lang="en-US">The following example uses the <emph>CBool</emph> function to evaluate the value that is returned by the <emph>Instr</emph> function. The function checks if the word "and" is found in the sentence that was entered by the user.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3156212" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340987280" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCBool</paragraph> +<paragraph id="par_idm1340986048" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US"> sText = InputBox("Please enter a short sentence:")</paragraph> +<paragraph id="par_id3155855" role="bascode" xml-lang="en-US"> ' Proof if the word »and« 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" role="bascode" xml-lang="en-US"> ' If Instr(Input, "and")<>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" role="bascode" xml-lang="en-US"> If CBool(Instr(sText, "and")) Then</paragraph> +<paragraph id="par_id3152940" role="bascode" xml-lang="en-US"> MsgBox "The word »and« appears in the sentence you entered!"</paragraph> +<paragraph id="par_idm1340972320" role="bascode" localize="false" xml-lang="en-US"> EndIf</paragraph> +<paragraph id="par_idm1340971088" 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/03100300.xhp b/helpcontent2/source/text/sbasic/shared/03100300.xhp new file mode 100644 index 000000000..e59c89351 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100300.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="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> + +<paragraph id="hd_id3148944" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<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" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3153525" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any string or numeric expression that you want to convert.</paragraph> +<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> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3156422" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..1913b3afb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100400.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="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> + +<paragraph id="hd_id3153750" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100400.xhp" name="CDbl Function">CDbl Function</link></paragraph> +<paragraph id="par_id3149233" role="paragraph" xml-lang="en-US">Converts any numerical expression or string expression to a double type.</paragraph> +</section> + +<paragraph id="hd_id3149516" role="heading" level="2" xml-lang="en-US">Syntax</paragraph> +<bascode> +<paragraph id="par_id3156152" role="bascode" xml-lang="en-US">CDbl (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3153061" role="heading" level="2" xml-lang="en-US">Return value</paragraph> +<paragraph id="par_id3145068" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 as normal text ("123.5") using the default number format of your operating system.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<section id="examplecountryconvert"> +<paragraph id="hd_id3148797" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340893312" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCountryConvert</paragraph> +<paragraph id="par_idm1340892064" role="bascode" localize="false" xml-lang="en-US"> MsgBox CDbl(1234.5678)</paragraph> +<paragraph id="par_idm1340890816" role="bascode" localize="false" xml-lang="en-US"> MsgBox CInt(1234.5678)</paragraph> +<paragraph id="par_idm1340889568" role="bascode" localize="false" xml-lang="en-US"> MsgBox CLng(1234.5678)</paragraph> +<paragraph id="par_idm1340888320" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</section> +</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..1727fe940 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100500.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="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> + +<paragraph id="hd_id3149346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100500.xhp" name="CInt Function">CInt Function</link></paragraph> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to an integer.</paragraph> +</section> + +<paragraph id="hd_id3147573" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154142" role="bascode" xml-lang="en-US">CInt (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3147531" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3145069" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any numeric expression that you want to convert. If the <emph>Expression</emph> exceeds the value range between -32768 and 32767, $[officename] Basic reports an overflow error. To convert a string expression, the number must be entered as normal text ("123.5") using the default number format of your operating system.</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/03100400.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..bc5b1dc68 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100600.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="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> + +<paragraph id="hd_id3153311" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100600.xhp" name="CLng Function">CLng Function</link></paragraph> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to a long integer.</paragraph> +</section> + +<paragraph id="hd_id3145315" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147573" role="bascode" xml-lang="en-US">CLng (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3145610" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US">Long</paragraph> + +<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any numerical expression that you want to convert. If the <emph>Expression</emph> lies outside the valid long integer range between -2.147.483.648 and 2.147.483.647, $[officename] Basic returns an overflow error. To convert a string expression, the number must be entered as normal text ("123.5") using the default number format of your operating system.</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/03100400.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..f1c12c480 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100700.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="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 a string as a constant.</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">Const Text = Expression</paragraph> +</bascode> + +<paragraph id="hd_id3147530" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any constant name that follows the standard variable naming conventions.</paragraph> +<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. Use the following statement to define a constant:</paragraph> +<paragraph id="par_id3150542" role="paragraph" xml-lang="en-US">CONST ConstName=Expression</paragraph> +<paragraph id="par_id3150400" role="paragraph" xml-lang="en-US">The type of expression is irrelevant. If a program is started, $[officename] Basic converts the program code internally so that each time a constant is used, the defined expression replaces it.</paragraph> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341161984" role="bascode" localize="false" xml-lang="en-US">Sub ExampleConst</paragraph> +<paragraph id="par_idm1341160752" role="bascode" localize="false" xml-lang="en-US"> Const iVar = 1964</paragraph> +<paragraph id="par_idm1341159520" role="bascode" localize="false" xml-lang="en-US"> MsgBox iVar</paragraph> +<paragraph id="par_id3153969" role="bascode" xml-lang="en-US"> Const sVar = "Program", dVar As Double = 1.00</paragraph> +<paragraph id="par_idm1341156544" role="bascode" localize="false" xml-lang="en-US"> MsgBox sVar & " " & dVar</paragraph> +<paragraph id="par_idm1341155296" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100900.xhp b/helpcontent2/source/text/sbasic/shared/03100900.xhp new file mode 100644 index 000000000..0ae154f02 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100900.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="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> + + +<paragraph id="hd_id3153753" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100900.xhp" name="CSng Function">CSng Function</link></paragraph> +<paragraph id="par_id3149748" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to data type Single.</paragraph> +</section> + +<paragraph id="hd_id3153255" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3148983" role="bascode" xml-lang="en-US">CSng (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153750" role="paragraph" xml-lang="en-US">Single</paragraph> + +<paragraph id="hd_id3146957" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153345" 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 as normal text ("123.5") using the default number format of your operating system.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149514" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341609456" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCSNG</paragraph> +<paragraph id="par_idm1341608224" role="bascode" localize="false" xml-lang="en-US"> MsgBox CDbl(1234.5678)</paragraph> +<paragraph id="par_idm1341606976" role="bascode" localize="false" xml-lang="en-US"> MsgBox CInt(1234.5678)</paragraph> +<paragraph id="par_idm1341605728" role="bascode" localize="false" xml-lang="en-US"> MsgBox CLng(1234.5678)</paragraph> +<paragraph id="par_idm1341604480" role="bascode" localize="false" xml-lang="en-US"> MsgBox CSng(1234.5678)</paragraph> +<paragraph id="par_idm1341603232" 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/03101000.xhp b/helpcontent2/source/text/sbasic/shared/03101000.xhp new file mode 100644 index 000000000..8ec92a79a --- /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" role="paragraph" xml-lang="en-US">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">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">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">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">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">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..e8b996221 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101100.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="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> + +<paragraph id="hd_id3145759" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101100.xhp" name="DefBool Statement">DefBool Statement</link></paragraph> +<paragraph id="par_id3153089" role="paragraph" xml-lang="en-US">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"> +<paragraph id="hd_id3149495" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150682" role="bascode" xml-lang="en-US">Defxxx Characterrange1[, Characterrange2[,...]]</paragraph> +</bascode> + +<paragraph id="hd_id3159201" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147226" role="paragraph" xml-lang="en-US"> <emph>Characterrange:</emph> Letters that specify the range of variables that you want to set the default data type for.</paragraph> +<paragraph id="par_id3149178" role="paragraph" xml-lang="en-US"> <emph>xxx:</emph> Keyword that defines the default variable type:</paragraph> +<paragraph id="par_id3150669" role="paragraph" xml-lang="en-US"> <emph>Keyword: </emph>Default variable type</paragraph> +</section> +<paragraph id="par_id3149233" role="paragraph" xml-lang="en-US"> <emph>DefBool:</emph> Boolean</paragraph> + +<section id="ExamplePrefixDefCommon"> +<paragraph id="hd_id3149762" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_id3156152" role="bascode" xml-lang="en-US">' Prefix definition for variable types:</paragraph> +<paragraph id="par_idm1341573120" role="bascode" localize="false" xml-lang="en-US">DefBool b</paragraph> +<paragraph id="par_idm1341571888" role="bascode" localize="false" xml-lang="en-US">DefDate t</paragraph> +<paragraph id="par_idm1341570656" role="bascode" localize="false" xml-lang="en-US">DefDbl d</paragraph> +<paragraph id="par_idm1341569424" role="bascode" localize="false" xml-lang="en-US">DefInt i</paragraph> +<paragraph id="par_idm1341568192" role="bascode" localize="false" xml-lang="en-US">DefLng l</paragraph> +<paragraph id="par_idm1341566960" role="bascode" localize="false" xml-lang="en-US">DefObj o</paragraph> +<paragraph id="par_idm1341565728" role="bascode" localize="false" xml-lang="en-US">DefVar v</paragraph> +</bascode> +</section> +<bascode> +<paragraph id="par_idm1341564496" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefBool</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" xml-lang="en-US">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..811225a30 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101110.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="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">DefCurr</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"/> +<paragraph role="paragraph" id="par_idN105B0" xml-lang="en-US"> +<emph>DefCur:</emph> Currency</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph role="bascode" id="par_idN105D3" xml-lang="en-US" localize="false">DefCur c</paragraph> +<paragraph role="bascode" id="par_idN105D6" xml-lang="en-US" localize="false">Sub ExampleDefCur</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" xml-lang="en-US" 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..7bdb551bb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101120.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="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> + +<paragraph id="par_idN1057D" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101120.xhp">DefErr Statement</link></paragraph> +<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"/> +<paragraph id="par_idN105B0" role="paragraph" xml-lang="en-US"> <emph>DefErr:</emph> Error</paragraph> + +<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..24b4deb94 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101130.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="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> + +<paragraph id="par_idN10577" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101130.xhp">DefSng Statement</link></paragraph> +<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"/> +<paragraph id="par_idN105AA" role="paragraph" xml-lang="en-US"> <emph>DefSng:</emph> Single</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph id="par_idm1341233824" role="bascode" localize="false" xml-lang="en-US">DefSng s</paragraph> +<paragraph id="par_idm1341232592" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefSng</paragraph> +<paragraph id="par_idN105D3" role="bascode" xml-lang="en-US"> sSng=Single ' sSng is an implicit single variable</paragraph> +<paragraph id="par_idm1341230096" role="bascode" localize="false" xml-lang="en-US">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..f9847edbd --- /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> + +<paragraph id="par_idN10577" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101140.xhp">DefStr Statement</link></paragraph> +<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"/> +<paragraph id="par_idN105AA" role="paragraph" xml-lang="en-US"> <emph>DefStr:</emph> String</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph id="par_idm1340827920" role="bascode" localize="false" xml-lang="en-US">DefStr s</paragraph> +<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_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..8dec758eb --- /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> + +<paragraph id="hd_id3150504" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101300.xhp" name="DefDate Statement">DefDate Statement</link></paragraph> +<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"/> +<paragraph id="par_id3150767" role="paragraph" xml-lang="en-US"> <emph>DefDate:</emph> Date</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph id="par_idm1341297408" role="bascode" localize="false" xml-lang="en-US">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_idm1341619984" role="bascode" localize="false" xml-lang="en-US">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..1522dd01b --- /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> + +<paragraph id="hd_id3147242" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101400.xhp" name="DefDbl Statement">DefDbl Statement</link></paragraph> +<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"/> +<paragraph id="par_id3154123" role="paragraph" xml-lang="en-US"> <emph>DefDbl:</emph> Double</paragraph> + +<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_id3153144" role="bascode" xml-lang="en-US"> dValue=1.23e43 ' dValue is an implicit double variable type</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..96e1cc57a --- /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> + +<paragraph id="hd_id3149811" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101500.xhp" name="DefInt Statement">DefInt Statement</link></paragraph> +<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"/> +<paragraph id="par_id3125863" role="paragraph" xml-lang="en-US"> <emph>DefInt:</emph> Integer</paragraph> + +<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_id3153728" role="bascode" xml-lang="en-US"> iCount=200 ' iCount is an implicit integer variable</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..c354d1638 --- /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> + +<paragraph id="hd_id3148538" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101600.xhp" name="DefLng Statement">DefLng Statement</link></paragraph> +<paragraph id="par_id3149514" 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"/> +<paragraph id="par_id3154686" role="paragraph" xml-lang="en-US"> <emph>DefLng:</emph> Long</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph id="par_idm871792224" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefLng</paragraph> +<paragraph id="par_id3145273" role="bascode" xml-lang="en-US"> lCount=123456789 ' lCount is an implicit long integer variable</paragraph> +<paragraph id="par_idm871789232" role="bascode" localize="false" xml-lang="en-US">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..42b09fc9f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101700.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="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> +<paragraph role="heading" id="hd_id3149811" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03101700.xhp" name="DefObj Statement">DefObj Statement</link></paragraph> +<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"/> +<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US"> +<emph>DefObj:</emph> Object</paragraph> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +</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..767a31950 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102000.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="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> + + +<paragraph id="hd_id3143267" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102000.xhp" name="DefVar Statement">DefVar Statement</link></paragraph> +<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> + +<paragraph id="hd_id3154143" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149514" role="bascode" xml-lang="en-US">Defxxx Characterrange1[, Characterrange2[,...]]</paragraph> +</bascode> + +<paragraph id="hd_id3156024" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>Characterrange:</emph> Letters that specify the range of variables that you want to set the default data type for.</paragraph> +<paragraph id="par_id3148552" role="paragraph" xml-lang="en-US"> <emph>xxx:</emph> Keyword that defines the default variable type:</paragraph> +<paragraph id="par_id3153524" role="paragraph" xml-lang="en-US"> <emph>Keyword: </emph>Default variable type</paragraph> +<paragraph id="par_id3150767" role="paragraph" xml-lang="en-US"> <emph>DefVar:</emph> Variant</paragraph> + +<paragraph id="hd_id3151041" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_id3156214" role="bascode" xml-lang="en-US">' Prefix definitions for variable types:</paragraph> +<paragraph id="par_idm1341099344" role="bascode" localize="false" xml-lang="en-US">DefBool b</paragraph> +<paragraph id="par_idm1341098112" role="bascode" localize="false" xml-lang="en-US">DefDate t</paragraph> +<paragraph id="par_idm1341096880" role="bascode" localize="false" xml-lang="en-US">DefDbl d</paragraph> +<paragraph id="par_idm1341095648" role="bascode" localize="false" xml-lang="en-US">DefInt i</paragraph> +<paragraph id="par_idm1341094416" role="bascode" localize="false" xml-lang="en-US">DefLng l</paragraph> +<paragraph id="par_idm1341093184" role="bascode" localize="false" xml-lang="en-US">DefObj o</paragraph> +<paragraph id="par_idm1341091952" role="bascode" localize="false" xml-lang="en-US">DefVar v</paragraph> +<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"> vDiv="Hello world"</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..7fc1e496f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102100.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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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"><link href="text/sbasic/shared/03102100.xhp" name="Dim Statement">Dim Statement</link></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="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> +</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..35011fce2 --- /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" role="paragraph" xml-lang="en-US">Bool</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..765ecb8ca --- /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" role="paragraph" xml-lang="en-US">Bool</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_id3150869" role="bascode" xml-lang="en-US"> Print IsDate(sDateVar) ' Returns True</paragraph> +<paragraph id="par_idm1340786096" role="bascode" localize="false" xml-lang="en-US"> sDateVar = "12121997"</paragraph> +<paragraph id="par_id3147288" role="bascode" xml-lang="en-US"> Print IsDate(sDateVar) ' Returns 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..d16dc7e18 --- /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" role="paragraph" xml-lang="en-US">Bool</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_id3154863" role="bascode" xml-lang="en-US"> Print IsEmpty(sVar) ' Returns 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..752fbacdf --- /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" role="paragraph" xml-lang="en-US">Bool</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..47fa8b657 --- /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" role="paragraph" xml-lang="en-US">Bool</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_id3147230" role="bascode" xml-lang="en-US"> Print IsNumeric(vVar) ' Returns False</paragraph> +<paragraph id="par_idm1341570224" role="bascode" localize="false" xml-lang="en-US"> vVar = "123"</paragraph> +<paragraph id="par_id3154910" role="bascode" xml-lang="en-US"> Print IsNumeric(vVar) ' Returns 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..650992598 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102800.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="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> +<paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03102800.xhp" name="IsObject Function">IsObject Function</link></paragraph> +<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="heading" id="hd_id3149234" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154285" xml-lang="en-US">IsObject(var)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3148685" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3156024" xml-lang="en-US">Boolean</paragraph> +<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3148552" xml-lang="en-US"> +<emph>var:</emph> Any variable that you want to test.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="paragraph" id="par_id891575896963115">The following objects return <literal>True</literal>:</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> + <section id="relatedtopics"> + <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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102900.xhp b/helpcontent2/source/text/sbasic/shared/03102900.xhp new file mode 100644 index 000000000..957e589c4 --- /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" xml-lang="en-US">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..05cc3c862 --- /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" role="paragraph" xml-lang="en-US">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" 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" xml-lang="en-US"> Print LBound(t), UBound(t()) ' returns 10 20</paragraph> +<paragraph id="par_id3149665" role="bascode" xml-lang="en-US"> Print LBound(t(),2) ' returns - 5</paragraph> +<paragraph id="par_id3159154" role="bascode" 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/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..687b1ffb9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103350.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="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> +<paragraph id="par_id051720171055367194" role="note" xml-lang="en-US">The support for VBA is not complete, but covers a large portion of the common usage patterns.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> +<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..ff74db48e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103600.xhp @@ -0,0 +1,277 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3143267" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103600.xhp" name="TypeName Function; VarType Function">TypeName Function; VarType Function</link></paragraph> +<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> + +<paragraph id="hd_id3153825" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155341" role="bascode" xml-lang="en-US">TypeName (Variable) / VarType (Variable)</paragraph> +</bascode> + +<paragraph id="hd_id3145610" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US">String; Integer</paragraph> + +<paragraph id="hd_id3146795" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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> + +<table id="tbl_id3153362"> + <tablerow> + <tablecell> + <paragraph id="par_id3145171" role="tablehead" xml-lang="en-US">key word</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">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> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149338" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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..dbbfa1cb3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103700.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="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>New keyword</bookmark_value> + <bookmark_value>Nothing object</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3154422" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103700.xhp" name="Set Statement">Set Statement</link></paragraph> +<paragraph id="par_id3159149" role="paragraph" xml-lang="en-US">Sets an object reference on a variable.</paragraph> +</section> + +<paragraph id="hd_id3153105" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<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> + +<paragraph id="hd_id3154685" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US"> <emph>variable:</emph> a variable or a property that requires an object reference.</paragraph> + <paragraph role="paragraph" id="par_id211588241663649"> <emph>expression: </emph> A computable combination of terms such as a formula or an object property or method.</paragraph> +<paragraph id="par_id3159252" role="paragraph" xml-lang="en-US"> <emph>object:</emph> Object that the variable refers to.</paragraph> +<paragraph id="par_idN10623" role="paragraph" xml-lang="en-US"> <literal>Nothing</literal> - Assign <literal>Nothing</literal> to a variable to remove a previous assignment.</paragraph> +<note id="par_id101586014505785" xml-lang="en-US"><literal>Set</literal> keyword is optional. <literal>Nothing</literal> is the default value for objects.</note> +<paragraph id="hd_id3159153" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340836336" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSet</paragraph> +<paragraph id="par_idm1340835104" role="bascode" localize="false" xml-lang="en-US"> Dim obj As Object</paragraph> +<paragraph id="par_idm1340833872" role="bascode" localize="false" xml-lang="en-US"> Set obj = ThisComponent</paragraph> +<paragraph id="par_idm1340832624" role="bascode" localize="false" xml-lang="en-US"> Print obj.Title</paragraph> +<paragraph id="par_idm1341832624" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340832625" role="bascode" localize="false" xml-lang="en-US"> obj = New com.sun.star.beans.PropertyValue</paragraph> +<paragraph id="par_idm1340832626" role="bascode" localize="false" xml-lang="en-US"> With obj</paragraph> +<paragraph id="par_idm1340832627" role="bascode" localize="false" xml-lang="en-US"> .Name = "key" : .Value = 594.34</paragraph> +<paragraph id="par_idm1340832628" role="bascode" localize="false" xml-lang="en-US"> Print .Name, .Value</paragraph> +<paragraph id="par_idm1340931399" role="bascode" localize="false" xml-lang="en-US"> End With</paragraph> +<paragraph id="par_idm1340831399" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<tip id="par_id841586014507226" xml-lang="en-US"><literal>New</literal> creates UNO objects or <link href="text/sbasic/shared/classmodule" name="ClassModule">class module</link> objects, before assigning it to a variable.</tip> +</body> + +</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..4657343f2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104200.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="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> +<paragraph role="heading" id="hd_id3150499" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104200.xhp" name="Array Function">Array Function</link></paragraph> +<paragraph role="paragraph" id="par_id3155555" xml-lang="en-US">Returns the type Variant with a data field.</paragraph> +</section> +<paragraph role="heading" id="hd_id3148538" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3153126" xml-lang="en-US">Array ( Argument list)</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US">See also <link href="text/sbasic/shared/03104300.xhp" name="DimArray">DimArray</link></paragraph> +<paragraph role="heading" id="hd_id3150669" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US"> +<emph>Argument list:</emph> A list of any number of arguments that are separated by commas.</paragraph> +<paragraph role="heading" id="hd_id3156343" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3153897" xml-lang="en-US">Dim A As Variant</paragraph> + <paragraph role="bascode" id="par_id3153525" xml-lang="en-US">A = Array("Fred","Tom","Bill")</paragraph> + <paragraph role="bascode" localize="false" id="par_id3150792" xml-lang="en-US">Msgbox A(2)</paragraph> +</bascode> +</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..c378ee698 --- /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 ( Argument list)</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>Argument list:</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..510b18fc2 --- /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" id="par_id3148538" xml-lang="en-US">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..c97e8916f --- /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" role="paragraph" xml-lang="en-US">Bool</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..1339f6bc6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104600.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="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> +<paragraph role="heading" id="hd_id3149205" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104600.xhp" name="EqualUnoObjects Function">EqualUnoObjects Function</link></paragraph> +<paragraph role="paragraph" id="par_id3145090" xml-lang="en-US">Returns True if the two specified Basic Uno objects represent the same Uno object instance.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" localize="false" id="par_id3150669" xml-lang="en-US">EqualUnoObjects( oObj1, oObj2 )</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_id3154285" xml-lang="en-US">Bool</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="par_id3156024" xml-lang="en-US">' Copy of objects -> same instance</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154923" xml-lang="en-US">oIntrospection = CreateUnoService( "com.sun.star.beans.Introspection" )</paragraph> + <paragraph role="bascode" localize="false" id="par_id3147559" xml-lang="en-US">oIntro2 = oIntrospection</paragraph> + <paragraph role="bascode" localize="false" id="par_id3150541" xml-lang="en-US">print EqualUnoObjects( oIntrospection, oIntro2 )</paragraph> + <paragraph role="bascode" id="par_id3153525" xml-lang="en-US">' Copy of structs as value -> new instance</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154366" xml-lang="en-US">Dim Struct1 as new com.sun.star.beans.Property</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154348" xml-lang="en-US">Struct2 = Struct1</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154125" xml-lang="en-US">print EqualUnoObjects( Struct1, Struct2 )</paragraph> +</bascode> +</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/03110000.xhp b/helpcontent2/source/text/sbasic/shared/03110000.xhp new file mode 100644 index 000000000..57de37d1e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03110000.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="textsbasicshared03110000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Comparison Operators</title> +<filename>/text/sbasic/shared/03110000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="vergleich"> + <paragraph id="hd_id3155555" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03110000.xhp" name="Comparison Operators">Comparison Operators</link></paragraph> + <paragraph role="paragraph" id="par_id3153528" xml-lang="en-US">The available comparison operators are described here.</paragraph> + </section> + <embed href="text/sbasic/shared/03110100.xhp#operatoren"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03110100.xhp b/helpcontent2/source/text/sbasic/shared/03110100.xhp new file mode 100644 index 000000000..65af4360d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03110100.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="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="operatoren"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"> + <bookmark_value>comparison operators;%PRODUCTNAME Basic</bookmark_value> + <bookmark_value>operators;comparisons</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150682" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03110100.xhp" name="Comparison Operators">Comparison Operators</link></paragraph> +<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 True (-1) or False (0).</paragraph> +</section> + +<paragraph id="hd_id3147291" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149177" role="bascode" xml-lang="en-US">Result = Expression1 { = | < | > | <= | >= } Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3145316" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Boolean expression that specifies the result of the comparison (True, or False)</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> + +<paragraph id="hd_id3154686" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341075248" role="bascode" localize="false" xml-lang="en-US">Sub ExampleUnequal</paragraph> +<paragraph id="par_idm1341074016" role="bascode" localize="false" xml-lang="en-US">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" xml-lang="en-US"> sRoot = "c:\"</paragraph> +<paragraph id="par_idm1341069792" role="bascode" localize="false" xml-lang="en-US"> sFile = Dir$( sRoot ,22)</paragraph> +<paragraph id="par_idm1341068544" role="bascode" localize="false" xml-lang="en-US"> If sFile <> "" Then</paragraph> +<paragraph id="par_idm1341067296" role="bascode" localize="false" xml-lang="en-US"> Do</paragraph> +<paragraph id="par_idm1341066064" role="bascode" localize="false" xml-lang="en-US"> MsgBox sFile</paragraph> +<paragraph id="par_idm1341064816" role="bascode" localize="false" xml-lang="en-US"> sFile = Dir$</paragraph> +<paragraph id="par_idm1341063568" role="bascode" localize="false" xml-lang="en-US"> Loop Until sFile = ""</paragraph> +<paragraph id="par_idm1341062320" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341061088" 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/03120000.xhp b/helpcontent2/source/text/sbasic/shared/03120000.xhp new file mode 100644 index 000000000..16c686713 --- /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="zeichen"> + <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#zeichen"/> + <embed href="text/sbasic/shared/03120300.xhp#manipu"/> + <embed href="text/sbasic/shared/03120400.xhp#ermitteln"/> + </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..d5e7a7eaf --- /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> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120101.xhp" name="Asc Function">Asc Function</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the ASCII (American Standard Code for Information Interchange) value of the first character in a string expression.</paragraph> +</section> + +<paragraph id="hd_id3155555" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3143267" role="bascode" xml-lang="en-US">Asc (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3147242" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150669" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3148473" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"> <emph>Text:</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"/> + +<paragraph id="hd_id3159413" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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("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"> +<paragraph id="par_idN1067B" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120102.xhp">CHR</link></paragraph> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120102.xhp b/helpcontent2/source/text/sbasic/shared/03120102.xhp new file mode 100644 index 000000000..a18c3beb1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120102.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="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> + <paragraph id="hd_id3149205" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120102.xhp" name="Chr Function">Chr Function</link></paragraph> + <paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">Returns the character that corresponds to the specified character code.</paragraph> + </section> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + + <paragraph id="par_id3150669" role="code" xml-lang="en-US">Chr(Expression As Integer)</paragraph> + + <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>Expression:</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>), <emph>Expression</emph> 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"/> + <paragraph role="paragraph" id="par_id111552916434071"><embedvar href="text/sbasic/shared/00000003.xhp#err6"/>, when VBA compatibility mode is enabled and expression is greater than 255.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_idm1341138080" role="bascode" localize="false" xml-lang="en-US">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 id="par_idm1341131568" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <paragraph id="par_idN10668" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120101.xhp">ASC</link></paragraph> + </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..d214ed606 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120103.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="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> + + +<paragraph id="hd_id3143272" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120103.xhp" name="Str Function">Str Function</link></paragraph> +<paragraph id="par_id3155100" role="paragraph" xml-lang="en-US">Converts a numeric expression into a string.</paragraph> +</section> + +<paragraph id="hd_id3109850" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">Str (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3150040" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3146117" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3155805" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149178" role="paragraph" xml-lang="en-US"> <emph>Expression: </emph>Any numeric expression.</paragraph> +<paragraph id="par_id3146958" role="paragraph" xml-lang="en-US">The <emph>Str</emph> function converts a numeric variable, or the result of a calculation into a string. Negative numbers are preceded by a minus sign. Positive numbers are preceded by a space (instead of the plus sign).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3155419" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341439760" role="bascode" localize="false" xml-lang="en-US">Sub ExampleStr</paragraph> +<paragraph id="par_idm1341438528" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Single</paragraph> +<paragraph id="par_idm1341437296" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341436064" role="bascode" localize="false" xml-lang="en-US"> iVar = 123.123</paragraph> +<paragraph id="par_idm1341434832" role="bascode" localize="false" xml-lang="en-US"> sVar = LTrim(Str(iVar))</paragraph> +<paragraph id="par_idm1341433584" role="bascode" localize="false" xml-lang="en-US"> MsgBox sVar & chr(13) & Str(iVar)</paragraph> +<paragraph id="par_idm1341432272" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..8d34db2a8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120104.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="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> + + +<paragraph id="hd_id3149205" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120104.xhp" name="Val Function">Val Function</link></paragraph> +<paragraph id="par_id3153345" role="paragraph" xml-lang="en-US">Converts a string to a numeric expression.</paragraph> +</section> + +<paragraph id="hd_id3159157" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149514" role="bascode" xml-lang="en-US">Val (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3150669" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3143228" role="paragraph" xml-lang="en-US">Double</paragraph> + +<paragraph id="hd_id3156024" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154348" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> String that represents a number.</paragraph> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Using the Val function, you can convert a string that represents numbers into numeric expressions. This is the inverse of the <emph>Str</emph> function. 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, the <emph>Val</emph> function returns the value 0.</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_idm1341084240" role="bascode" localize="false" xml-lang="en-US">Sub ExampleVal</paragraph> +<paragraph id="par_idm1341083008" role="bascode" localize="false" xml-lang="en-US"> MsgBox Val("123.123")</paragraph> +<paragraph id="par_idm1341081760" role="bascode" localize="false" xml-lang="en-US"> MsgBox Val("A123.123")</paragraph> +<paragraph id="par_idm1341080512" 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/03120105.xhp b/helpcontent2/source/text/sbasic/shared/03120105.xhp new file mode 100644 index 000000000..e4d8befc2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120105.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="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> +<paragraph role="heading" id="hd_id3156027" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120105.xhp" name="CByte Function">CByte Function</link></paragraph> +<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">Converts a string or a numeric expression to the type Byte.</paragraph> +</section> +<paragraph role="heading" id="hd_id3149811" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3147573" xml-lang="en-US">Cbyte( expression )</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3145315" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US">Byte</paragraph> +<paragraph role="heading" id="hd_id3147530" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3145068" xml-lang="en-US"> +<emph>Expression:</emph> A string or a numeric expression.</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/03120111.xhp b/helpcontent2/source/text/sbasic/shared/03120111.xhp new file mode 100644 index 000000000..4ee05ef53 --- /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> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120111.xhp" name="AscW Function [VBA]">AscW Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">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 (Text As String)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" xml-lang="en-US">Integer</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"> <emph>Text:</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("Ω") ' 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"> +<paragraph id="par_idN1067B" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120102.xhp">Chr</link></paragraph> +<paragraph id="par_id051920171027053197" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120112.xhp">ChrW</link></paragraph> +<paragraph id="par_id051920171027051338" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120101.xhp">Asc</link></paragraph> +</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..39f9cebee --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120112.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="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> + + +<paragraph id="hd_id3149205" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120112.xhp" name="ChrW Function">ChrW Function [VBA]</link></paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">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" xml-lang="en-US">ChrW(Expression As Integer)</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>Expression:</emph> Numeric variables 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,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" xml-lang="en-US">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 id="par_idm1341131568" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id051920171010491586" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120102.xhp">Chr</link></paragraph> +<paragraph id="par_idN10668" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120101.xhp">Asc</link></paragraph> +<paragraph id="par_id051920171009414669" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/03120111.xhp">AscW</link></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120200.xhp b/helpcontent2/source/text/sbasic/shared/03120200.xhp new file mode 100644 index 000000000..5d58edee1 --- /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="zeichen"> + <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..815a840c7 --- /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> + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120201.xhp" name="Space Function">Space and Spc Functions</link></paragraph> +<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 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_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..e088ee718 --- /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> + + +<paragraph id="hd_id3147291" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120202.xhp" name="String Function">String Function</link></paragraph> +<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> + +<paragraph id="hd_id3149516" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149233" role="bascode" xml-lang="en-US">String (n As Long, {expression As Integer | character As String})</paragraph> +</bascode> + +<paragraph id="hd_id3143270" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3147530" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3154923" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 65535.</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"/> + +<paragraph id="hd_id3152920" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120300.xhp b/helpcontent2/source/text/sbasic/shared/03120300.xhp new file mode 100644 index 000000000..024dbd09f --- /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"> +<bookmark xml-lang="en-US" branch="index" id="bm_id7499008"><bookmark_value>ampersand symbol in StarBasic</bookmark_value> +</bookmark><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 & operator to concatenate strings.</paragraph> +</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..3f19ae6de --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120301.xhp @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3153539" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120301.xhp" name="Format Function">Format Function</link></paragraph> +<paragraph id="par_id3156042" role="paragraph" xml-lang="en-US">Converts a number to a string, and then formats it according to the format that you specify.</paragraph> +</section> + +<paragraph id="hd_id3145090" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153527" role="bascode" xml-lang="en-US">Format (Number [, Format As String])</paragraph> +</bascode> + +<paragraph id="hd_id3149178" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3148474" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3159176" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"> <emph>Number:</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 <emph>Format</emph> is omitted, the Format function works like the <emph>Str</emph> function.</paragraph> + +<paragraph id="hd_id3147561" role="heading" level="2" xml-lang="en-US">Formatting Codes</paragraph> +<paragraph id="par_id3147265" role="paragraph" xml-lang="en-US">The following list describes the codes that you can use for formatting a number:</paragraph> +<paragraph id="par_id3153380" role="paragraph" xml-lang="en-US"> <emph>0:</emph> If <emph>Number</emph> has a digit at the position of the 0 in the format code, the digit is displayed, otherwise a zero is displayed.</paragraph> +<paragraph id="par_id3151210" role="paragraph" xml-lang="en-US">If <emph>Number</emph> has fewer digits than the number of zeros in the format code, (on either side of the decimal), leading or trailing zeros are displayed. If the number has more digits to the left of the decimal separator than the amount of zeros in the format code, the additional digits are displayed without formatting.</paragraph> +<paragraph id="par_id3151176" role="paragraph" xml-lang="en-US">Decimal places in the number are rounded according to the number of zeros that appear after the decimal separator in the <emph>Format </emph>code.</paragraph> +<paragraph id="par_id3154123" role="paragraph" xml-lang="en-US"> <emph>#:</emph> If <emph>Number</emph> contains a digit at the position of the # placeholder in the <emph>Format</emph> 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 format code than digits in the number. Only the relevant digits of the number 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 format 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 number by 100 and inserts the percent sign (%) where the number appears in the format code.</paragraph> +<paragraph id="par_id3149481" role="paragraph" xml-lang="en-US"> <emph>E- E+ e- e+ :</emph> If the format code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the number 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 format 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 format 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">\ : The backslash displays the next character in the format code.</paragraph> +<paragraph id="par_id3153366" role="paragraph" xml-lang="en-US">Characters in the format 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 "General Number", 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> + +<paragraph id="hd_id3149377" role="heading" level="2" xml-lang="en-US">Predefined format</paragraph> +<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 format 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 format code, it applies to all numbers.</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_id3149019" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..361545bfb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120302.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="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> + + +<paragraph id="hd_id3152363" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120302.xhp" name="LCase Function">LCase Function</link></paragraph> +<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" 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 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_id3146121" role="bascode" xml-lang="en-US"> Print LCase(sVar) ' Returns "las vegas"</paragraph> +<paragraph id="par_id3146986" role="bascode" xml-lang="en-US"> Print UCase(sVar) ' Returns "LAS VEGAS"</paragraph> +<paragraph id="par_idm1341096336" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..cc0b41a88 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120303.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="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> + + +<paragraph id="hd_id3149346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120303.xhp" name="Left Function">Left Function</link></paragraph> +<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> + +<paragraph id="hd_id3156153" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150771" role="bascode" xml-lang="en-US">Left (Text As String, n As Long)</paragraph> +</bascode> + +<paragraph id="hd_id3153824" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3147530" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3148946" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 65535.</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"/> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120304.xhp b/helpcontent2/source/text/sbasic/shared/03120304.xhp new file mode 100644 index 000000000..19e9d6450 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120304.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="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> + + +<paragraph id="hd_id3143268" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120304.xhp" name="LSet Statement">LSet Statement</link></paragraph> +<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> + +<paragraph id="hd_id3145317" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150984" role="bascode" xml-lang="en-US">LSet Var As String = Text or LSet Var1 = Var2</paragraph> +</bascode> + +<paragraph id="hd_id3143271" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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> + +<paragraph id="hd_id3156282" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120305.xhp b/helpcontent2/source/text/sbasic/shared/03120305.xhp new file mode 100644 index 000000000..4cec0d7d7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120305.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="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> + + +<paragraph id="hd_id3147574" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120305.xhp" name="LTrim Function">LTrim Function</link></paragraph> +<paragraph id="par_id3145316" role="paragraph" xml-lang="en-US">Removes all leading spaces at the start of a string expression.</paragraph> +</section> + +<paragraph id="hd_id3154924" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3148552" role="bascode" xml-lang="en-US">LTrim (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3151056" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3150543" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3145419" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120306.xhp b/helpcontent2/source/text/sbasic/shared/03120306.xhp new file mode 100644 index 000000000..bc95904c3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120306.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="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> + + +<paragraph id="hd_id3143268" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120306.xhp" name="Mid Function, Mid Statement">Mid Function, Mid Statement</link></paragraph> +<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> + +<paragraph id="hd_id3154285" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<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> + +<paragraph id="hd_id3145068" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3149295" role="paragraph" xml-lang="en-US">String (only by Function)</paragraph> + +<paragraph id="hd_id3154347" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 maximum allowed value is 65535.<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 65535.</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"/> + +<paragraph id="hd_id3149560" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120307.xhp b/helpcontent2/source/text/sbasic/shared/03120307.xhp new file mode 100644 index 000000000..4b6a7af3a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120307.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="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> + + +<paragraph id="hd_id3153311" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120307.xhp" name="Right Function">Right Function</link></paragraph> +<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> + +<paragraph id="hd_id3145315" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153061" role="bascode" xml-lang="en-US">Right (Text As String, n As Long)</paragraph> +</bascode> + +<paragraph id="hd_id3145068" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3146795" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 65535.</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"/> + +<paragraph id="hd_id3156212" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</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..7ac77340e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120308.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="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> + + +<paragraph id="hd_id3153345" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120308.xhp" name="RSet Statement">RSet Statement</link></paragraph> +<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> + +<paragraph id="hd_id3149234" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150669" role="bascode" xml-lang="en-US">RSet Text As String = Text or RSet Variable1 = Variable2</paragraph> +</bascode> + +<paragraph id="hd_id3156024" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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> + +<paragraph id="hd_id3154909" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120309.xhp b/helpcontent2/source/text/sbasic/shared/03120309.xhp new file mode 100644 index 000000000..ec7b1cb1c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120309.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="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> + + +<paragraph id="hd_id3154286" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120309.xhp" name="RTrim Function">RTrim Function</link></paragraph> +<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> + +<paragraph id="hd_id3154924" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154347" role="bascode" xml-lang="en-US">RTrim (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3148798" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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"/> + +<paragraph id="hd_id3151041" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120310.xhp b/helpcontent2/source/text/sbasic/shared/03120310.xhp new file mode 100644 index 000000000..5c052abd2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120310.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="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> + + +<paragraph id="hd_id3153527" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120310.xhp" name="UCase Function">UCase Function</link></paragraph> +<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" role="paragraph" xml-lang="en-US">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_id3149204" role="bascode" xml-lang="en-US"> Print LCase(sVar) ' returns "las vegas"</paragraph> +<paragraph id="par_id3156280" role="bascode" xml-lang="en-US"> Print UCase(sVar) ' returns "LAS VEGAS"</paragraph> +<paragraph id="par_idm1340871632" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..5dd60bae2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120311.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="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> + + +<paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120311.xhp" name="Trim Function">Trim Function</link></paragraph> +<paragraph id="par_id3149177" role="paragraph" xml-lang="en-US">Removes all leading and trailing spaces from a string expression.</paragraph> +</section> + +<paragraph id="hd_id3159157" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155341" role="bascode" xml-lang="en-US">Trim( Text As String )</paragraph> +</bascode> + +<paragraph id="hd_id3155388" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3143228" role="paragraph" xml-lang="en-US">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"> <emph>Text:</emph> Any string expression.</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_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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120312.xhp b/helpcontent2/source/text/sbasic/shared/03120312.xhp new file mode 100644 index 000000000..3c17b560b --- /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> +<paragraph role="heading" id="hd_id3152801" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120312.xhp" name="ConvertToURL Function">ConvertToURL Function</link></paragraph> +<paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Converts a system file name to a file URL.</paragraph> +</section> +<paragraph role="heading" id="hd_id3150669" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154285" xml-lang="en-US">ConvertToURL(filename)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150984" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3147530" xml-lang="en-US">String</paragraph> +<paragraph role="heading" id="hd_id3148550" xml-lang="en-US" level="2">Parameters:</paragraph> +<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"> +<paragraph role="heading" id="hd_id3153361" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> + <paragraph role="bascode" 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> +</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..c9a98ce0a --- /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> +<paragraph role="heading" id="hd_id3153894" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120313.xhp" name="ConvertFromURL Function">ConvertFromURL Function</link></paragraph> +<paragraph role="paragraph" id="par_id3147226" xml-lang="en-US">Converts a file URL to a system file name.</paragraph> +</section> +<paragraph role="heading" id="hd_id3143267" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154142" xml-lang="en-US">ConvertFromURL(filename)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3159157" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3150669" xml-lang="en-US">String</paragraph> +<paragraph role="heading" id="hd_id3143270" xml-lang="en-US" level="2">Parameters:</paragraph> +<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"/> +</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..aae47d81c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120314.xhp @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120314.xhp" name="Split Function">Split Function</link></paragraph> +<paragraph id="par_id3155805" role="paragraph" xml-lang="en-US">Returns an array of substrings from a string expression.</paragraph> +</section> + +<paragraph id="hd_id3149177" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153824" role="bascode" xml-lang="en-US">Split (Text As String, delimiter, number)</paragraph> +</bascode> + +<paragraph id="hd_id3149763" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154285" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3145315" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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> + +<paragraph id="hd_id3150398" role="heading" level="2" xml-lang="en-US">Example:</paragraph> + +<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> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120315.xhp b/helpcontent2/source/text/sbasic/shared/03120315.xhp new file mode 100644 index 000000000..286c33e5d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120315.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="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> +<paragraph role="heading" id="hd_id3149416" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120315.xhp" name="Join Function">Join Function</link></paragraph> +<paragraph role="paragraph" id="par_id3149670" xml-lang="en-US">Returns a string from a number of substrings in a string array.</paragraph> +</section> +<paragraph role="heading" id="hd_id3159414" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3156344" xml-lang="en-US">Join (Text As String Array, delimiter)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150400" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3150359" xml-lang="en-US">String</paragraph> +<paragraph role="heading" id="hd_id3148798" xml-lang="en-US" level="2">Parameters:</paragraph> +<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> +<paragraph role="heading" id="hd_id3154218" xml-lang="en-US" level="2">Example:</paragraph> +<embed href="text/sbasic/shared/03120314.xhp#splitjoinex"/> +</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..3250f7718 --- /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="ermitteln"> + <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..a1ccb0bf7 --- /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> + + +<paragraph id="hd_id3155934" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120401.xhp" name="InStr Function">InStr Function</link></paragraph> +<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> + +<paragraph id="hd_id3145090" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3146957" role="bascode" xml-lang="en-US">InStr ([Start As Long,] Text1 As String, Text2 As String[, Compare])</paragraph> +</bascode> + +<paragraph id="hd_id3148538" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3149763" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3148473" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<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 maximum allowed value is 65535.<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 return parameter is omitted.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<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_id3144760" role="bascode" xml-lang="en-US"> sInput = "Office"</paragraph> +<paragraph id="par_id3154125" role="bascode" 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..f619c6bfe --- /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" id="par_id3143270" xml-lang="en-US">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"> MsgBox Len(sText) REM Returns 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..0f59c4dcb --- /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" role="paragraph" xml-lang="en-US">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..34be721d6 --- /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" role="paragraph" xml-lang="en-US">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_id3144760" role="bascode" xml-lang="en-US"> sInput = "The book is on the table"</paragraph> +<paragraph id="par_id3154125" 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_id051920170322141162" role="bascode" xml-lang="en-US"> iPos = InStrRev(sInput,"the",10,0) ' Returns 0, search is case-sensitive</paragraph> +<paragraph id="par_id051920170322458754" 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" role="paragraph" xml-lang="en-US"><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..0bf1202fb --- /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" role="paragraph" xml-lang="en-US">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..0dae75465 --- /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="sonstige"> +<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..5db50f3a1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130100.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="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> +<paragraph role="heading" id="hd_id3143284" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03130100.xhp" name="Beep Statement">Beep Statement</link></paragraph> +<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> +<paragraph role="heading" id="hd_id3153990" xml-lang="en-US" level="2">Syntax:</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"/> +<paragraph role="heading" id="hd_id3148538" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3149762" xml-lang="en-US" localize="false">Sub ExampleBeep</paragraph> +<paragraph role="bascode" id="par_id3154285" xml-lang="en-US" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3143270" xml-lang="en-US" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3154142" xml-lang="en-US" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3148943" xml-lang="en-US" 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..3bc1f9b10 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130500.xhp @@ -0,0 +1,130 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + + +<paragraph id="hd_id3150040" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03130500.xhp" name="Shell Function">Shell Function</link></paragraph> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Starts another application and defines the respective window style, if necessary.</paragraph> +</section> + +<paragraph id="hd_id3153345" role="heading" level="2" xml-lang="en-US">Syntax</paragraph> +<paragraph id="par_id3147576" role="paragraph" xml-lang="en-US">Shell (Pathname As String[, Windowstyle As Integer][, Param As String][, bSync]) </paragraph> + +<paragraph id="hd_id3149235" role="heading" level="2" xml-lang="en-US">Parameter</paragraph> + +<paragraph id="hd_id3154306" role="heading" level="3" xml-lang="en-US">Pathname</paragraph> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Complete path and program name of the program that you want to start.</paragraph> + +<paragraph id="hd_id3150771" role="heading" level="3" xml-lang="en-US">Windowstyle</paragraph> +<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"> + <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> + + +<paragraph id="hd_id3150419" role="heading" level="3" xml-lang="en-US">Param</paragraph> +<paragraph id="par_id3149412" role="paragraph" xml-lang="en-US">Any string expression that specifies the command line that want to pass.</paragraph> + +<paragraph id="hd_id3148456" role="heading" level="3" xml-lang="en-US">bSync</paragraph> +<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"/> + +<paragraph id="hd_id3154270" role="heading" level="2" xml-lang="en-US">Example</paragraph> +<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>
\ No newline at end of file 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..1e68ce7aa --- /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 Long</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..5e4c4a491 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130700.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="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" role="paragraph" xml-lang="en-US">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> +</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..ff03a4256 --- /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" role="paragraph" xml-lang="en-US">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..b0c499b8c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131600.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="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;FunctionAccess</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 ProcessServiceManager.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3153346" role="code" xml-lang="en-US">oService = CreateUnoService( Uno service name )</paragraph> + +<paragraph id="par_idN1060F" role="paragraph" xml-lang="en-US">For a list of available services, go to: <link href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html" name="api.libreoffice.org com::sun::star Module Reference">https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html</link></paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bookmark xml-lang="en-US" branch="index" id="bm_id731561653332192"> +<bookmark_value>Calc functions;API Service</bookmark_value> +</bookmark> +<paragraph role="paragraph" id="par_id891561653344669">Calling Calc functions in Basic:</paragraph> +<section id="calcinternalfunctions"> +<bascode> + <paragraph role="bascode" id="par_id741592351349391" xml-lang="en-US">REM The code below does not work for add-in functions, which have a different calling procedure.</paragraph> + <paragraph role="bascode" id="par_id511561653511948" xml-lang="en-US" localize="false">Function MyVlook(item, InRange As Object, FromCol As Integer)</paragraph> + <paragraph role="bascode" id="par_id771561653522280" xml-lang="en-US" localize="false"> Dim oService As Object</paragraph> + <paragraph role="bascode" id="par_id791561653536896" xml-lang="en-US" localize="false"> oService = createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="bascode" id="par_id31561653863623" xml-lang="en-US"> REM Always use the function English name</paragraph> + <paragraph role="bascode" id="par_id391561653548274" xml-lang="en-US" localize="false"> MyVlook = oService.callFunction("VLOOKUP",Array(item, InRange, FromCol, True))</paragraph> + <paragraph role="bascode" id="par_id951561653556383" xml-lang="en-US" localize="false">End Function</paragraph> +</bascode> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph id="par_id3154046" role="paragraph" localize="false" xml-lang="en-US"><literal>oIntrospection = CreateUnoService( "com.sun.star.beans.Introspection" )</literal></paragraph> +<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 a service to open 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="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"> filepicker.execute()</paragraph> +<paragraph id="par_idm1206767344" role="bascode" localize="false" xml-lang="en-US"> files = filepicker.getFiles()</paragraph> +<paragraph id="par_idm1206766192" role="bascode" localize="false" xml-lang="en-US"> FileOpenDialog=files(0)</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..a91107a43 --- /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" 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"><link href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope specifier</link></h1> +<paragraph role="paragraph" id="par_id991572457387308">To manage personal or shared library containers (<emph>%PRODUCTNAME Macros</emph> or <emph>My Macros</emph>) from within a document, use the <literal>GlobalScope</literal> specifier.</paragraph> +</section> +<section id="basicdialogs"> + <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>%PRODUCTNAME 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..52664aaef --- /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">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">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">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">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">ContListener_disposing</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3146923" role="listitem" xml-lang="en-US">ContListener_elementInserted</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3147318" role="listitem" xml-lang="en-US">ContListener_elementRemoved</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3152578" role="listitem" xml-lang="en-US">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_id3153876" role="bascode" 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_id3154098" role="bascode" 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_id3153947" role="bascode" 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_id3148915" role="bascode" 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..eb96a9964 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132200.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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> +<paragraph id="hd_id3155342" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03132200.xhp" name="ThisComponent Object">ThisComponent Object</link></paragraph> +<paragraph id="par_id3154923" role="paragraph" xml-lang="en-US">Addresses the active component whose properties can be read and set, and whose methods can be called. <literal>ThisComponent</literal> is used in Basic, where it represents the current document. Properties and methods available through <literal>ThisComponent</literal> depend on the document type.<comment>see i60932</comment></paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3151056" role="code" localize="false" xml-lang="en-US">ThisComponent</paragraph> +<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> +</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..e405a5a3e --- /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>TypeConverter</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..32c3b0573 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132400.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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> +<paragraph id="par_idN10580" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03132400.xhp">CreateObject Function</link></paragraph> +<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 id="par_idN105A6" role="code" xml-lang="en-US">oObj = CreateObject( type )</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341251920" role="bascode" localize="false" xml-lang="en-US">Type address</paragraph> +<paragraph id="par_idm1341250688" role="bascode" localize="false" xml-lang="en-US"> Name1 As String</paragraph> +<paragraph id="par_idm1341249456" role="bascode" localize="false" xml-lang="en-US"> City As String</paragraph> +<paragraph id="par_idm1341248224" role="bascode" localize="false" xml-lang="en-US">End Type</paragraph> +<paragraph id="par_idm1341246992" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341245744" role="bascode" localize="false" xml-lang="en-US">Sub main</paragraph> +<paragraph id="par_idm1341244512" role="bascode" localize="false" xml-lang="en-US"> myaddress = CreateObject("address")</paragraph> +<paragraph id="par_idm1341243264" role="bascode" localize="false" xml-lang="en-US"> MsgBox IsObject(myaddress)</paragraph> +<paragraph id="par_idm1341242016" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</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..6ad2ca1a6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03150000.xhp @@ -0,0 +1,140 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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> + <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> + + <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..443b07229 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03160000.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="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> + + + <paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03160000.xhp" name="Input Function [VBA]">Input Function [VBA]</link></paragraph> + <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 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 role="bascode" id="par_id371512159801764" xml-lang="en-US" localize="false">Sub Example_Input</paragraph> + <paragraph role="bascode" id="par_id291512159796937" xml-lang="en-US" localize="false"> Dim MyData</paragraph> + <paragraph role="bascode" id="par_id251512159786757" xml-lang="en-US" localize="false"> Open "MyDataFile.txt" For Input As #1</paragraph> + <paragraph role="bascode" id="par_id271512159778620" xml-lang="en-US" localize="false"> Do While Not EOF(1)</paragraph> + <paragraph role="bascode" id="par_id361512159768651" xml-lang="en-US" localize="false"> MyData = Input(1, #1)</paragraph> + <paragraph role="bascode" id="par_id551512159751248" xml-lang="en-US" localize="false"> Print MyData</paragraph> + <paragraph role="bascode" id="par_id321512159745050" xml-lang="en-US" localize="false"> Loop</paragraph> + <paragraph role="bascode" id="par_id61512159730602" xml-lang="en-US" localize="false"> Close #1</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/sbasic/shared/03020202.xhp">Input# statement</link></paragraph> + <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..b6ac5a4ff --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03170000.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="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</bookmark_value> + </bookmark> + <paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03170000.xhp" name="Round Function [VBA]">Round Function [VBA]</link></paragraph> + <paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">The Round function returns a number rounded to a specified number of digits.</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">Round( expression as Double [,numdecimalplaces as Integer] ) </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>expression</emph>: Required. The numeric expression to be rounded.</paragraph> + <paragraph id="par_id240720170117395610" role="paragraph" xml-lang="en-US"><emph>numdecimalplaces</emph>: Optional. Specifies how many places to the right of the decimal are included in the rounding. Default 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 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 role="bascode" id="par_id701512162274019" xml-lang="en-US" localize="false">Sub Example_Round</paragraph> + <paragraph role="bascode" id="par_id501512162266839" xml-lang="en-US" localize="false"> Dim r </paragraph> + <paragraph role="bascode" id="par_id91512162260091" xml-lang="en-US" localize="false"> r = Pi</paragraph> + <paragraph role="bascode" id="par_id571512162254456" xml-lang="en-US" localize="false"> print r ' 3,14159265358979</paragraph> + <paragraph role="bascode" id="par_id831512162245783" xml-lang="en-US" localize="false"> print Round(r, 5) ' 3,14159</paragraph> + <paragraph role="bascode" id="par_id981512162218659" xml-lang="en-US" localize="false"> r = exp(1)</paragraph> + <paragraph role="bascode" id="par_id761512162210883" xml-lang="en-US" localize="false"> print r ' 2,71828182845904</paragraph> + <paragraph role="bascode" id="par_id521512162200022" xml-lang="en-US" localize="false"> print Round(r) ' 3</paragraph> + <paragraph id="par_id240720170144221275" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <paragraph id="par_id061420170153186193" role="paragraph" xml-lang="en-US"><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..cf582c729 --- /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 TestFormatNumeber</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..b4d2c8b37 --- /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="makro"> +<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/ErrVBA.xhp b/helpcontent2/source/text/sbasic/shared/ErrVBA.xhp new file mode 100644 index 000000000..dc1c2d802 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/ErrVBA.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/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">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"><emph>Description</emph> property gives the nature of the error. It details the various reasons that may cause the error. Ideally, it provides the multiple course of actions to help solve the issue and prevent its reoccurrence. Its alias is Basic <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">This the error code associated with the error. <literal>Err</literal> object default property is <emph>Number</emph>. Its alias is %PRODUCTNAME Basic <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. Its alias is %PRODUCTNAME Basic <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. Its alias is %PRODUCTNAME Basic <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> + <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> + <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 intented 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"/> + </section> + </body> +</helpdocument>
\ No newline at end of file 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..f2f6b0d56 --- /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 neverending 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..7f0169fd7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/calc_functions.xhp @@ -0,0 +1,865 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.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">Calling 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>macros;calling Calc function</bookmark_value> + <bookmark_value>createUNOservice function;calling Calc function</bookmark_value> + <bookmark_value>API;addin.Analysis</bookmark_value> +</bookmark> +<h1 id="hd_id91592352089011"><variable id="CallingCalcFunctionsh1"><link href="text/sbasic/shared/calc_functions.xhp" name="Calling Calc Functions">Calling Calc Functions</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.</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"/> +<embed href="text/sbasic/shared/03131600.xhp#calcinternalfunctions"/> +<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 service <literal>com.sun.star.sheet.addin.Analysis</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="bas_id421592358343633">REM Example calling Addin function SQRTPI</paragraph> +<paragraph role="bascode" id="bas_id731592358351744">Function MySQRTPI(arg as double) as double</paragraph> +<paragraph role="bascode" id="bas_id731592358361242"> Dim oService as Object</paragraph> +<paragraph role="bascode" id="bas_id971592358368906"> 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">End Function</paragraph> +</bascode> + +<table id="tab_id971592356505781"> + <tablerow> + <tablecell> + <paragraph id="par_id511592356505781" role="tablehead" xml-lang="en-US" localize="false">Calc Function name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471592356505782" role="tablehead" xml-lang="en-US" localize="false">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_id221592355620084" 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_id51592355688940" 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 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..13d95b9cb --- /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" xml-lang="en-US">Option ClassModule</title> + <filename>/text/sbasic/shared/classmodule.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0082"> + <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" 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..5425a87b5 --- /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" 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/compatibilitymode.xhp b/helpcontent2/source/text/sbasic/shared/compatibilitymode.xhp new file mode 100644 index 000000000..6340361b9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/compatibilitymode.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/. + * + --> + <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 is controlling runtime mode and affects all code executed after setting or resetting the mode. </paragraph> + </section> + <warning id="N0119">Use this feature with caution, limit it to document conversion for example.</warning> + <note id="par_id271561645872679"><literal>Option Compatible</literal> turns on VBA compatibility at module level for the %PRODUCTNAME Basic interpreter.</note> + <paragraph role="paragraph" id="N0121">This function may affect or help in the following situations:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0122">Creating enumerations with <link href="text/sbasic/shared/enum.xhp" name="enum statement">Enum statement</link></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 behaviour 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> + </list> + <note id="N0126"><literal>CompatibilityMode()</literal> function may be necessary when resorting to <literal>Option Compatible</literal> or <literal>Option VBASupport</literal> compiler modes.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" localize="false" id="N0128">CompatibilityMode(True | False)</paragraph> + <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" xml-lang="en-US" localize="false">Sub RemoveDir</paragraph> + <paragraph role="bascode" id="par_id771561646565613" xml-lang="en-US" localize="false"> CompatibilityMode( true )</paragraph> + <paragraph role="bascode" id="par_id311561646572637" xml-lang="en-US" localize="false"> RmDir( "file:///home/me/Test" )</paragraph> + <paragraph role="bascode" id="par_id851561646579895" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id461561646613414">With <literal>CompatibilityMode( true )</literal> the program results in an error, otherwise the Test 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" xml-lang="en-US" localize="false">Sub VBADirCommand</paragraph> + <paragraph role="bascode" id="par_id831561647900147" xml-lang="en-US"> CompatibilityMode( true ) ' Shows also normal files</paragraph> + <paragraph role="bascode" id="par_id931561647920869" xml-lang="en-US" localize="false"> Entry$ = Dir( "file:///home/me/Tmp/*.*", 16 )</paragraph> + <paragraph role="bascode" id="par_id31561647939939" xml-lang="en-US" localize="false"> Total$ = ""</paragraph> + <paragraph role="bascode" id="par_id71561647964220" xml-lang="en-US" localize="false"> While Entry$ <> ""</paragraph> + <paragraph role="bascode" id="par_id51561647969918" xml-lang="en-US" localize="false"> Total$ = Total$ + Entry$ + Chr$(13)</paragraph> + <paragraph role="bascode" id="par_id111561647975134" xml-lang="en-US" localize="false"> Entry$ = Dir</paragraph> + <paragraph role="bascode" id="par_id751561647979743" xml-lang="en-US" localize="false"> Wend</paragraph> + <paragraph role="bascode" id="par_id401561647986945" xml-lang="en-US" localize="false"> MsgBox Total$</paragraph> + <paragraph role="bascode" id="par_id111561647991525" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + <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 <literal>Option Compatible</literal> simple 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> + <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..b3e44cd0d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/compatible.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/. + * + --> + <meta> + <topic id="text/sbasic/shared/compatible"> + <title id="tit" xml-lang="en-US">Option Compatible</title> + <filename>/text/sbasic/shared/compatible.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0103"> + <bookmark_value>Option Compatible</bookmark_value> + <bookmark_value>VBA compatibility option</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> turns on the VBA-compatible Basic compiler mode at the module level.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> + <note id="par_id931561646897105">The function <link href="text/sbasic/shared/compatibilitymode.xhp" name="copatibilitymode"><literal>CompatibilityMode()</literal></link> controls runtime mode and affects all code executed after setting or resetting the mode.</note> + <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">Support <literal>Private</literal>/<literal>Public</literal> keywords for procedures.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0111">Compulsory <literal>Set</literal> statement for objects.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0112">Default values for optional parameters in procedures.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0113">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> sets <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/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..f0ecbd388 --- /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></variable>argument fragment</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"><link href="text/sbasic/shared/fragments.xhp" name="data types fragment">typename fragment</link></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"><link href="text/sbasic/shared/fragments.xhp" name="type declaration characters fragment">char fragment</link></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/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..ab262d685 --- /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="makro"> + <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#uebersetzen"/> + <embed href="text/sbasic/shared/02/11020000.xhp#syuebersetzen"/> + <embed href="text/sbasic/shared/02/11030000.xhp#ausfuehren"/> + <embed href="text/sbasic/shared/02/11030000.xhp#syausfuehren"/> + <embed href="text/sbasic/shared/02/11040000.xhp#anhalten"/> + <embed href="text/sbasic/shared/02/11040000.xhp#syanhalten"/> + <embed href="text/sbasic/shared/02/11060000.xhp#prozedurschritt"/> + <embed href="text/sbasic/shared/02/11060000.xhp#syprozedurschritt"/> + <embed href="text/sbasic/shared/02/11050000.xhp#einzelschritt"/> + <embed href="text/sbasic/shared/02/11050000.xhp#syeinzelschritt"/> + <embed href="text/sbasic/shared/02/11160000.xhp#ruecksprung"/> + <embed href="text/sbasic/shared/02/11160000.xhp#syruecksprung"/> + <embed href="text/sbasic/shared/02/11070000.xhp#haltepunkt"/> + <embed href="text/sbasic/shared/02/11070000.xhp#syhaltepunkt"/> + <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#beobachter"/> + <embed href="text/sbasic/shared/02/11080000.xhp#sybeobachter"/> + <embed href="text/sbasic/shared/02/11090000.xhp#okatalog"/> + <embed href="text/sbasic/shared/02/11090000.xhp#syobjektkatalog"/> + <embed href="text/sbasic/shared/02/11100000.xhp#makros"/> + <embed href="text/sbasic/shared/02/11100000.xhp#symakros"/> + <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#klammer"/> + <embed href="text/sbasic/shared/02/11120000.xhp#syklammer"/> + <embed href="text/sbasic/shared/02/11140000.xhp#laden"/> + <embed href="text/sbasic/shared/02/11140000.xhp#syladen"/> + <embed href="text/sbasic/shared/02/11150000.xhp#speichern"/> + <embed href="text/sbasic/shared/02/11150000.xhp#syspeichern"/> + <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..19bf5c3c1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/main0601.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="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> + +<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_examples.xhp#pythonexamples2"/> + +<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_schedule.xhp#schedule_lib"/> +<embed href="text/sbasic/shared/03/lib_script.xhp#script_lib"/> +<embed href="text/sbasic/shared/03/lib_template.xhp#template_lib"/> + +<embed href="text/swriter/main0000.xhp#helpabouthelp"/> +</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..09e42f54e --- /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" id="par_id971548420129767" localize="false">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..31a489715 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/property.xhp @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this 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">Property Statement</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 dependant routines. Using <emph>Get</emph>, <emph>Let</emph> or <emph>Set</emph> accessers 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="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> + <paragraph role="paragraph" id="N0238"> + <link href="text/sbasic/shared/01020300.xhp" name ="Using Procedures and Fonctions">Using Procedures and Functions</link> + </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..7f4e825f1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/replace.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/. + * + --> + + <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"/> + <paragraph role="code" id="par_id931552552227310">Replace (Text As String, SearchStr As String, ReplStr As String [, Start As Long [, Count as Long [, Compare As Boolean]]]</paragraph> + + <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>Text:</emph> Any string expression that you want to modify.</paragraph> + <paragraph role="paragraph" id="par_id901552552269836"><emph>SearchStr:</emph> Any string expression that shall be searched for.</paragraph> + <paragraph role="paragraph" id="par_id791552552275383"><emph>ReplStr:</emph> Any string expression that shall replace the found search string.</paragraph> + <paragraph role="paragraph" id="par_id111552552283060"><emph>Start:</emph> 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> The maximal number of times the replace shall be 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 TRUE or FALSE. The default value of TRUE specifies a text comparison that is not case-sensitive. The value of FALSE specifies a binary comparison that is case-sensitive. You can as well use 0 instead of FALSE or 1 instead of TRUE.</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" >REM meaning: "b" should be replaced, but</paragraph> + <paragraph role="bascode" id="par_id571552552467647">REM * only when lowercase (parameter 6), hence second occurrence of "b"</paragraph> + <paragraph role="bascode" id="par_id71552552474769">REM * only first (respecting case) occurrence (parameter 5)</paragraph> + <paragraph role="bascode" id="par_id501587778372566" xml-lang="en-US" 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> + </bascode> +</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..32d98942e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/special_vba_func.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="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> + + +<paragraph id="hd_id051820170313205718" role="heading" level="1" xml-lang="en-US"><variable id="exclusivevba"><link href="text/sbasic/shared/special_vba_func.xhp">Exclusive VBA Functions and Statements</link></variable></paragraph> +<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> + <embed href="text/sbasic/shared/compatible.xhp#optioncompatiblestatement"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulefunction"/> + <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> +<paragraph id="par_id051820170355592834" role="heading" level="2" xml-lang="en-US">Text functions</paragraph> +<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"/> +</section> + +<section id="VBAFinancial"> + <bookmark xml-lang="en-US" branch="index" id="bm_id051920170357078705"> + <bookmark_value>VBA Functions;Financial Functions</bookmark_value> + </bookmark> +<paragraph id="par_id051820170355592581" role="heading" level="2" xml-lang="en-US">Financial functions</paragraph> +<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> +<paragraph id="par_id051820170356005357" role="heading" level="2" xml-lang="en-US">Date and time functions</paragraph> +<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> + +<paragraph id="par_id051820170356006501" role="heading" level="2" xml-lang="en-US">I/O Functions</paragraph> +<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> + +<paragraph id="par_id051820170356005221" role="heading" level="2" xml-lang="en-US">Mathematical Functions</paragraph> +<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> + +<paragraph id="hd_id051920170347039686" role="heading" level="2" xml-lang="en-US">Object Properties and Methods</paragraph> +<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/uno_objects.xhp b/helpcontent2/source/text/sbasic/shared/uno_objects.xhp new file mode 100644 index 000000000..6d8ae8d6a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/uno_objects.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="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">UNO Objects, Functions and Services</h1> + <paragraph role="paragraph" id="par_id3153312" xml-lang="en-US">Functions, objects and services of Unified Network Objects (UNO).</paragraph> + </section> + <h2 id="hd_id91572461246639"><link href="text/sbasic/shared/03131900.xhp#basicdialogs" name="basicanddialog">BasicLibraries Object</link></h2> + <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"/> + <h2 id="hd_id91572461246640"><link href="text/sbasic/shared/03131900.xhp#basicdialogs" name="basicanddialog">DialogLibraries Object</link></h2> + <embed href="text/sbasic/shared/03132500.xhp#getdefaultcontext"/> + <embed href="text/sbasic/shared/03131700.xhp#getprocessservicemanager"/> + <embed href="text/sbasic/shared/03131900.xhp#globalscope"/> + <embed href="text/sbasic/shared/03104400.xhp#hasunointerfaces"/> + <embed href="text/sbasic/shared/03104500.xhp#isunostruct"/> + <embed href="text/sbasic/shared/stardesktop.xhp#stardesktop"/> + <embed href="text/sbasic/shared/03132200.xhp#thiscomponent"/> + <note id="par_id81572615048011">%PRODUCTNAME provides an Application Programming Interface (API) that allows controlling the $[officename] components with different programming languages by using the $[officename] Software Development Kit (SDK). For more information about the $[officename] API and the Software Development Kit, visit <link href="https://api.libreoffice.org/" name="api.libreoffice.org">https://api.libreoffice.org</link></note> +</body> +</helpdocument> 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> |