diff options
| -rw-r--r-- | AllLangHelp_sbasic.mk | 8 | ||||
| -rw-r--r-- | source/auxiliary/sbasic.tree | 10 | ||||
| -rw-r--r-- | source/text/sbasic/shared/00000003.xhp | 10 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_depot.xhp | 28 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_euro.xhp | 30 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_formwizard.xhp | 28 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_gimnicks.xhp | 30 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_schedule.xhp | 30 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_script.xhp | 30 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_template.xhp | 28 | ||||
| -rw-r--r-- | source/text/sbasic/shared/03/lib_tools.xhp | 1360 | ||||
| -rw-r--r-- | source/text/sbasic/shared/main0601.xhp | 11 | ||||
| -rw-r--r-- | source/text/shared/need_help.xhp | 12 |
13 files changed, 1599 insertions, 16 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index 2ffab07cf7..b716effff1 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -67,6 +67,14 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/02/11180000 \ helpcontent2/source/text/sbasic/shared/02/11190000 \ helpcontent2/source/text/sbasic/shared/02/20000000 \ + helpcontent2/source/text/sbasic/shared/03/lib_tools \ + helpcontent2/source/text/sbasic/shared/03/lib_euro \ + helpcontent2/source/text/sbasic/shared/03/lib_depot \ + helpcontent2/source/text/sbasic/shared/03/lib_formwizard \ + helpcontent2/source/text/sbasic/shared/03/lib_gimnicks \ + helpcontent2/source/text/sbasic/shared/03/lib_script \ + helpcontent2/source/text/sbasic/shared/03/lib_schedule \ + helpcontent2/source/text/sbasic/shared/03/lib_template \ helpcontent2/source/text/sbasic/shared/03000000 \ helpcontent2/source/text/sbasic/shared/03010000 \ helpcontent2/source/text/sbasic/shared/03010100 \ diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index 02eb3bb2e5..97bd34e0d1 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -289,7 +289,17 @@ <topic id="sbasic/text/sbasic/shared/03070400.xhp">"/" Operator</topic> <topic id="sbasic/text/sbasic/shared/03070500.xhp">"^" Operator</topic> </node> + <node id="070205" title="Advanced Basic Libraries"> +<topic id="sbasic/text/sbasic/shared/03/lib_tools.xhp">Tools Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_depot.xhp">Depot Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_euro.xhp">Euro Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_formwizard.xhp">FormWizard Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_gimnicks.xhp">Gimnicks Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_schedule.xhp">Schedule Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_script.xhp">ScriptBindingLibrary Library</topic> +<topic id="sbasic/text/sbasic/shared/03/lib_template.xhp">Template Library</topic> </node> + </node> <node id="0703" title="Guides"> <topic id="shared/text/shared/guide/macro_recording.xhp">Recording a Macro</topic> <topic id="sbasic/text/sbasic/guide/control_properties.xhp">Changing the Properties of Controls in the Dialog Editor</topic> diff --git a/source/text/sbasic/shared/00000003.xhp b/source/text/sbasic/shared/00000003.xhp index a067682d98..a56925dcde 100644 --- a/source/text/sbasic/shared/00000003.xhp +++ b/source/text/sbasic/shared/00000003.xhp @@ -177,7 +177,13 @@ </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"> @@ -185,22 +191,18 @@ </section> <section id="functsyntax"> - <paragraph id="hd_id061420171139089682" role="heading" level="2" xml-lang="en-US"><variable id="functsyntax">Syntax:</variable></paragraph> </section> <section id="functvalue"> - <paragraph id="hd_id061420171139087480" role="heading" level="2" xml-lang="en-US"><variable id="functvalue">Return value:</variable></paragraph> </section> <section id="functparameters"> - <paragraph id="hd_id061420171139084157" role="heading" level="2" xml-lang="en-US"><variable id="functparameters">Parameters:</variable></paragraph> </section> <section id="functexample"> - <paragraph id="hd_id061420171139088233" role="heading" level="2" xml-lang="en-US"><variable id="functexample">Example:</variable></paragraph> </section> diff --git a/source/text/sbasic/shared/03/lib_depot.xhp b/source/text/sbasic/shared/03/lib_depot.xhp new file mode 100644 index 0000000000..2c4a01ba1f --- /dev/null +++ b/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/source/text/sbasic/shared/03/lib_euro.xhp b/source/text/sbasic/shared/03/lib_euro.xhp new file mode 100644 index 0000000000..5141854ee6 --- /dev/null +++ b/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/source/text/sbasic/shared/03/lib_formwizard.xhp b/source/text/sbasic/shared/03/lib_formwizard.xhp new file mode 100644 index 0000000000..c3ff82a118 --- /dev/null +++ b/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/source/text/sbasic/shared/03/lib_gimnicks.xhp b/source/text/sbasic/shared/03/lib_gimnicks.xhp new file mode 100644 index 0000000000..81240633c6 --- /dev/null +++ b/source/text/sbasic/shared/03/lib_gimnicks.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="basicgimnickslibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GIMNICKS Library</title> + <filename>/text/sbasic/shared/03/lib_gimnicks.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="gimnicks_lib"><link href="text/sbasic/shared/03/lib_gimnicks.xhp" name="Gimnicks library">The <item type="literal">Gimnicks</item> Library</link></variable></paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id951529070357301"> + <bookmark_value>BASIC Gimnicks 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("Gimnicks")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> diff --git a/source/text/sbasic/shared/03/lib_schedule.xhp b/source/text/sbasic/shared/03/lib_schedule.xhp new file mode 100644 index 0000000000..3f5bc7ef3a --- /dev/null +++ b/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 Template 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/source/text/sbasic/shared/03/lib_script.xhp b/source/text/sbasic/shared/03/lib_script.xhp new file mode 100644 index 0000000000..1fabfa1626 --- /dev/null +++ b/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/source/text/sbasic/shared/03/lib_template.xhp b/source/text/sbasic/shared/03/lib_template.xhp new file mode 100644 index 0000000000..f7e093fa0c --- /dev/null +++ b/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/source/text/sbasic/shared/03/lib_tools.xhp b/source/text/sbasic/shared/03/lib_tools.xhp new file mode 100644 index 0000000000..07d5f5f649 --- /dev/null +++ b/source/text/sbasic/shared/03/lib_tools.xhp @@ -0,0 +1,1360 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.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> + <paragraph id="par_id251529001003857" role="bascode" xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id71529001663903" role="bascode" xml-lang="en-US" localize="false">DeactivateReadOnlyFlag</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951529001706210" role="bascode" xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag(</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421529001727178" role="bascode" xml-lang="en-US" localize="false">SetBasicReadOnlyFlag</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771529001755355" role="bascode" xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id651529001954868" role="bascode" xml-lang="en-US" localize="false">WritedbgInfo</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581529001865055" role="bascode" xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841529001994821" role="bascode" xml-lang="en-US" localize="false">WriteDbgString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171529002013434" role="bascode" xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as string)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741529002099962" role="bascode" xml-lang="en-US" localize="false">ShowArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261529002118559" role="bascode" xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id321529002327444" role="bascode" xml-lang="en-US" localize="false">ShowPropertyValues</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501529002327444" role="bascode" xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451529002368600" role="bascode" xml-lang="en-US" localize="false">ShowNameValuePair</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321529002368600" role="bascode" xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph> + </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> + <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> + </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> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591529003562090" role="bascode" xml-lang="en-US" localize="false">ShowCommands</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791529003562091" role="bascode" xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881529003602892" role="bascode" xml-lang="en-US" localize="false">ProtectCurrentSheets</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531529003602892" role="bascode" xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691529003635074" role="bascode" xml-lang="en-US" localize="false">FillDocument</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371529003635074" role="bascode" xml-lang="en-US" localize="false">Sub FillDocument()</paragraph> + </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">Miscelaneous 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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id501529006725521" role="bascode" xml-lang="en-US" localize="false">ConnecttoDatabase</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id411529006832985" role="bascode" xml-lang="en-US" localize="false">GetStarOfficeLocale</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361529006902547" role="bascode" xml-lang="en-US" localize="false">GetRegistryKeyContent</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851529006965105" role="bascode" xml-lang="en-US" localize="false">GetProductname</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451529006965105" role="bascode" xml-lang="en-US" localize="false">Function GetProductname() as String</paragraph> + </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" xml-lang="en-US">' Opens a Document, checks beforehand, wether it has to be loaded or wether it is already on the desktop. If the parameter bDisposable is set to False then then returned document should not be disposed afterwards, because it is already opened.</paragraph> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id481529007130534" role="bascode" xml-lang="en-US" localize="false">TaskonDesktop</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911529007130534" role="bascode" xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph> + </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" xml-lang="en-US">' Retrieves a FileName out of a StarOffice-Document</paragraph> + <paragraph role="bascode" id="par_id881529007259806" xml-lang="en-US" localize="false">Function RetrieveFileName(LocDoc as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id121529007269721" role="bascode" xml-lang="en-US" localize="false">GetPathSettings</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id801529007338550" xml-lang="en-US">' Gets a special configured PathSetting</paragraph> + <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> + </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" 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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591529007658281" role="bascode" xml-lang="en-US" localize="false">ShowNoOfficePathError</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511529007658281" role="bascode" xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431529007692356" role="bascode" xml-lang="en-US" localize="false">InitResources</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id611529007790857" role="bascode" xml-lang="en-US" localize="false">GetResText</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id331529007790857" role="bascode" xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As string</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971529007839780" role="bascode" xml-lang="en-US" localize="false">CutPathView</paragraph> + </tablecell> + <tablecell> + <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> + </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" xml-lang="en-US">' Deletes the content of all cells that are softformatted according to the 'InputStyleName'</paragraph> + <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> + </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">' Inserts a certain String to all cells of a Range that ist passed over either as an object or as the RangeName</paragraph> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547275154" role="bascode" localize="false" xml-lang="en-US">ReplaceRangeValues</paragraph> + </tablecell> + <tablecell> + <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> + </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">' Returns the Value of the first cell of a Range</paragraph> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547273177" role="bascode" localize="false" xml-lang="en-US">DuplicateRow</paragraph> + </tablecell> + <tablecell> + <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> + </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">' Returns the String of the first cell of a Range</paragraph> + <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> + </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">' Returns a named Cell</paragraph> + <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> + </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">' Changes the numeric Value of a cell by transmitting the String of the numeric Value</paragraph> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547283259" role="bascode" localize="false" xml-lang="en-US">GetDocumentType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547286797" role="bascode" localize="false" xml-lang="en-US">Function GetDocumentType(oDocument)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547288146" role="bascode" localize="false" xml-lang="en-US">GetNumberFormatType</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547282335" role="bascode" localize="false" xml-lang="en-US">ProtectSheets</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547283563" role="bascode" localize="false" xml-lang="en-US">Sub ProtectSheets(Optional oSheets as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547285130" role="bascode" localize="false" xml-lang="en-US">UnprotectSheets</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547289761" role="bascode" localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional oSheets as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547284142" role="bascode" localize="false" xml-lang="en-US">GetRowIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547284556" role="bascode" localize="false" xml-lang="en-US">GetColumnIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547285141" role="bascode" localize="false" xml-lang="en-US">CopySheetbyName</paragraph> + </tablecell> + <tablecell> + <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> + </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">' Dis-or enables a Window and adjusts the mousepointer accordingly</paragraph> + <paragraph id="par_id061420180547296555" role="bascode" localize="false" xml-lang="en-US">Sub ToggleWindow(bDoEnable as Boolean)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547294361" role="bascode" localize="false" xml-lang="en-US">CheckNewSheetname</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547298278" role="bascode" localize="false" xml-lang="en-US">AddNewSheetName</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547293964" role="bascode" localize="false" xml-lang="en-US">GetSheetIndex</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id06142018054729713" role="bascode" localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as Integer</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547298034" role="bascode" localize="false" xml-lang="en-US">GetLastUsedRow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547299520" role="bascode" localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph> + </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">' 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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054729303" role="bascode" localize="false" xml-lang="en-US">AttachBasicMacroToEvent</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547308735" role="bascode" localize="false" xml-lang="en-US">ModifyPropertyValue</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054730528" role="bascode" localize="false" xml-lang="en-US">GetPropertyValueIndex</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547305379" role="bascode" localize="false" xml-lang="en-US">DispatchSlot</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547302087" role="bascode" localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as Integer)</paragraph> + </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">'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> + <paragraph id="par_id061420180547302561" role="bascode" localize="false" xml-lang="en-US">Function IsFatOffice() As Boolean</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018054730408" role="bascode" localize="false" xml-lang="en-US">GetLocale</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547305357" role="bascode" localize="false" xml-lang="en-US">ToggleDesignMode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547301559" role="bascode" localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547301521" role="bascode" localize="false" xml-lang="en-US">isHighContrast</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180547302307" role="bascode" localize="false" xml-lang="en-US">Function isHighContrast(oPeer as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180547302524" role="bascode" localize="false" xml-lang="en-US">CreateNewDocument</paragraph> + </tablecell> + <tablecell> + <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> + </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" 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> + <paragraph id="par_id061420180547301077" role="bascode" localize="false" xml-lang="en-US">Sub DisposeDocument(oDocument as Object)</paragraph> + </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">'Function to calculate if the year is a leap year</paragraph> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06152018072841458" role="bascode" localize="false" xml-lang="en-US">GetRefValueOfControlGroup</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728416653" role="bascode" localize="false" xml-lang="en-US">GetOptionGroupValue</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728419761" role="bascode" localize="false" xml-lang="en-US">WriteOptValueToCell</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728411084" role="bascode" localize="false" xml-lang="en-US">LoadDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728417528" role="bascode" localize="false" xml-lang="en-US">GetFolderName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728414273" role="bascode" localize="false" xml-lang="en-US">Sub GetFolderName(oRefModel as Object)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728412942" role="bascode" localize="false" xml-lang="en-US">GetFileName</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728414394" role="bascode" localize="false" xml-lang="en-US">StoreDocument</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728424363" role="bascode" localize="false" xml-lang="en-US">AddFiltersToDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728422388" role="bascode" localize="false" xml-lang="en-US">SwitchMousePointer</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728428854" role="bascode" localize="false" xml-lang="en-US">ShowOverwriteAllDialog</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728429649" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToQuery</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728429597" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToQuery()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061520180728428255" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToAlways</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728424733" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToAlways()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06152018072842702" role="bascode" localize="false" xml-lang="en-US">SetOVERWRITEToNever</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061520180728429250" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToNever()</paragraph> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <paragraph id="par_id061420180708315325" role="bascode" localize="false" xml-lang="en-US">Sub ClearArray(BigArray)</paragraph> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708324642" role="bascode" localize="false" xml-lang="en-US">MultiArrayInListbox</paragraph> + </tablecell> + <tablecell> + <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> + </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 Searchindexex 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> + <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> + </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> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708331666" role="bascode" localize="false" xml-lang="en-US">ArrayfromMultiArray</paragraph> + </tablecell> + <tablecell> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070834616" role="bascode" localize="false" xml-lang="en-US">GetFileNameExtension</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708342472" role="bascode" localize="false" xml-lang="en-US">GetFileNameWithoutExtension</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708347642" role="bascode" localize="false" xml-lang="en-US">DirectoryNameoutofPath</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708348485" role="bascode" localize="false" xml-lang="en-US">CountCharsinString</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180708344129" role="bascode" localize="false" xml-lang="en-US">BubbleSortList</paragraph> + </tablecell> + <tablecell> + <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> + <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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070835957" role="bascode" localize="false" xml-lang="en-US">AddListtoList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018070835769" role="bascode" localize="false" xml-lang="en-US">CheckDouble</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180708359797" role="bascode" localize="false" xml-lang="en-US">Function CheckDouble(DoubleString as String)</paragraph> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727437838" role="bascode" localize="false" xml-lang="en-US">AddFoldertoList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727432439" role="bascode" localize="false" xml-lang="en-US">AddFileNameToList</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727448222" role="bascode" localize="false" xml-lang="en-US">RetrieveDocTitle</paragraph> + </tablecell> + <tablecell> + <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> + </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> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727441712" role="bascode" localize="false" xml-lang="en-US">CopyRecursively</paragraph> + </tablecell> + <tablecell> + <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> + </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> + <paragraph id="par_id061420180727444009" role="bascode" localize="false" xml-lang="en-US">Sub ShowHelperDialog(aEvent)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727442283" role="bascode" localize="false" xml-lang="en-US">SaveDataToFile</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id061420180727442501" role="bascode" localize="false" xml-lang="en-US">LoadDataFromFile</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id06142018072744521" role="bascode" localize="false" xml-lang="en-US">CreateFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061420180727443924" role="bascode" localize="false" xml-lang="en-US">Function CreateFolder(sNewFolder) as Boolean</paragraph> + </tablecell> + </tablerow> + </table> + </section> +</body> +</helpdocument> diff --git a/source/text/sbasic/shared/main0601.xhp b/source/text/sbasic/shared/main0601.xhp index b0cd578425..558ea5c635 100644 --- a/source/text/sbasic/shared/main0601.xhp +++ b/source/text/sbasic/shared/main0601.xhp @@ -50,6 +50,17 @@ <embed href="text/sbasic/shared/vbasupport.xhp#vbamacros"/> <embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> +<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_gimnicks.xhp#gimnicks_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"/> + <paragraph id="hd_id3148473" role="heading" level="3" xml-lang="en-US">Help about the Help</paragraph> <embed href="text/shared/05/00000100.xhp#neuehilfe"/> <embed href="text/shared/05/00000110.xhp#00000110"/> diff --git a/source/text/shared/need_help.xhp b/source/text/shared/need_help.xhp index e39e271c22..a21fcac3b5 100644 --- a/source/text/shared/need_help.xhp +++ b/source/text/shared/need_help.xhp @@ -6,16 +6,6 @@ * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. - * - * This file incorporates work covered by the following license notice: - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed - * with this work for additional information regarding copyright - * ownership. The ASF licenses this file to you under the Apache - * License, Version 2.0 (the "License"); you may not use this file - * except in compliance with the License. You may obtain a copy of - * the License at http://www.apache.org/licenses/LICENSE-2.0 . --> <meta> @@ -26,8 +16,6 @@ </meta> <body> - - <section id="needhelp"> <paragraph id="hd_id1000010" role="warning" xml-lang="en-US">This help page needs further work for correctness and completion. Please join the LibreOffice project and help us out to write the missing information. Visit our <link href="http://documentation.libreoffice.org/en/join-community/update-help-contents">web page on writing Help contents</link>.</paragraph> </section> |