source/text/sbasic/shared/03/lib_tools.xhp | 1127 ++++++++++++++--------------- 1 file changed, 568 insertions(+), 559 deletions(-)
New commits: commit ea59b72bfa1b74e1b3a294778ec1d490d4e6962b Author: Olivier Hallot <olivier.hal...@libreoffice.org> AuthorDate: Sun Jul 9 11:12:12 2023 -0300 Commit: Olivier Hallot <olivier.hal...@libreoffice.org> CommitDate: Tue Jul 11 12:38:50 2023 +0200 Add example on how to get user data from registry Special thanks to Rafael Lima and and Mike Kaganski Change-Id: I6bd04949680a2f11468debacd23be686e38fdf25 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/154228 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org> diff --git a/source/text/sbasic/shared/03/lib_tools.xhp b/source/text/sbasic/shared/03/lib_tools.xhp index 28982fe469..6ce490a599 100644 --- a/source/text/sbasic/shared/03/lib_tools.xhp +++ b/source/text/sbasic/shared/03/lib_tools.xhp @@ -11,828 +11,837 @@ <meta> <topic id="toolsbasiclibrary" indexer="include" status="PUBLISH"> - <title id="tit" xml-lang="en-US">Tools Library</title> + <title id="tit">Tools Library</title> <filename>/text/sbasic/shared/03/lib_tools.xhp</filename> </topic> </meta> <body> <h1 id="hd_id31529004750471"><variable id="tools_lib"><link href="text/sbasic/shared/03/lib_tools.xhp">The <item type="literal">Tools</item> Library</link></variable></h1> - <bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774"> + <bookmark 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"><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"><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"><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"><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"><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"><item type="literal">UCB</item> Module</link></paragraph> - <bookmark xml-lang="en-US" branch="index" id="bm_id271529062442803"> + <note id="par_id901528999850603"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Tools")</item></note> + <paragraph role="paragraph" id="par_id161529001339405"><link href="text/sbasic/shared/03/lib_tools.xhp#debug_module"><item type="literal">Debug</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id41529001348561"><link href="text/sbasic/shared/03/lib_tools.xhp#listbox_module"><item type="literal">ListBox</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id341529001354451"><link href="text/sbasic/shared/03/lib_tools.xhp#misc_module"><item type="literal">Misc</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id311529001362049"><link href="text/sbasic/shared/03/lib_tools.xhp#modulecontrols_module"><item type="literal">ModuleControls</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id701529001368064"><link href="text/sbasic/shared/03/lib_tools.xhp#strings_module"><item type="literal">Strings</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id251529001373426"><link href="text/sbasic/shared/03/lib_tools.xhp#ucb_module"><item type="literal">UCB</item> Module</link></paragraph> + <bookmark branch="index" id="bm_id271529062442803"> <bookmark_value>BASIC Tools library;Debug module</bookmark_value> </bookmark> <section id="debug_module"> <h2 id="hd_id371529000826947"><item type="literal">Debug</item> Module</h2> - <paragraph role="paragraph" id="par_id441529064369519" xml-lang="en-US">Functions and subroutines for debugging Basic macros.</paragraph> - <h3 id="hd_id711529001004857" xml-lang="en-US" localize="false">ActivateReadOnlyFlag</h3> + <paragraph role="paragraph" id="par_id441529064369519">Functions and subroutines for debugging Basic macros.</paragraph> + <h3 id="hd_id711529001004857" localize="false">ActivateReadOnlyFlag</h3> <bascode> - <paragraph id="par_id251529001003857" role="bascode" xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph> + <paragraph id="par_id251529001003857" role="bascode" localize="false">Sub ActivateReadOnlyFlag()</paragraph> </bascode> - <h3 id="hd_id71529001663903" xml-lang="en-US" localize="false">DeactivateReadOnlyFlag</h3> + <h3 id="hd_id71529001663903" localize="false">DeactivateReadOnlyFlag</h3> <bascode> - <paragraph id="par_id951529001706210" role="bascode" xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag()</paragraph> + <paragraph id="par_id951529001706210" role="bascode" localize="false">Sub DeactivateReadOnlyFlag()</paragraph> </bascode> - <h3 id="hd_id421529001727178" xml-lang="en-US" localize="false">SetBasicReadOnlyFlag</h3> + <h3 id="hd_id421529001727178" localize="false">SetBasicReadOnlyFlag</h3> <bascode> - <paragraph id="par_id771529001755355" role="bascode" xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph> + <paragraph id="par_id771529001755355" role="bascode" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph> </bascode> - <h3 id="hd_id651529001954868" xml-lang="en-US" localize="false">WritedbgInfo</h3> + <h3 id="hd_id651529001954868" localize="false">WritedbgInfo</h3> <bascode> - <paragraph id="par_id581529001865055" role="bascode" xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph> + <paragraph id="par_id581529001865055" role="bascode" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph> </bascode> - <h3 id="hd_id841529001994821" xml-lang="en-US" localize="false">WriteDbgString</h3> + <h3 id="hd_id841529001994821" localize="false">WriteDbgString</h3> <bascode> - <paragraph id="par_id171529002013434" role="bascode" xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as String)</paragraph> + <paragraph id="par_id171529002013434" role="bascode" localize="false">Sub WriteDbgString(LocString as String)</paragraph> </bascode> - <h3 id="hd_id741529002099962" xml-lang="en-US" localize="false">ShowArray</h3> + <h3 id="hd_id741529002099962" localize="false">ShowArray</h3> <bascode> - <paragraph id="par_id261529002118559" role="bascode" xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph> + <paragraph id="par_id261529002118559" role="bascode" localize="false">Sub ShowArray(LocArray())</paragraph> </bascode> - <h3 id="hd_id321529002327444" xml-lang="en-US" localize="false">ShowPropertyValues</h3> + <h3 id="hd_id321529002327444" localize="false">ShowPropertyValues</h3> <bascode> - <paragraph id="par_id501529002327444" role="bascode" xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph> + <paragraph id="par_id501529002327444" role="bascode" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph> </bascode> - <h3 id="hd_id451529002368600" xml-lang="en-US" localize="false">ShowNameValuePair</h3> + <h3 id="hd_id451529002368600" localize="false">ShowNameValuePair</h3> <bascode> - <paragraph id="par_id321529002368600" role="bascode" xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph> + <paragraph id="par_id321529002368600" role="bascode" localize="false">Sub ShowNameValuePair(Pair())</paragraph> </bascode> - <h3 id="hd_id551529002415495" xml-lang="en-US" localize="false">ShowElementNames</h3> - <paragraph id="par_id111529003255859" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the Elements of aSequence of an object, with the</paragraph> - <paragraph id="par_id41529003238747" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <h3 id="hd_id551529002415495" localize="false">ShowElementNames</h3> + <paragraph id="par_id111529003255859" role="paragraph" localize="false">' Retrieves all the Elements of aSequence of an object, with the</paragraph> + <paragraph id="par_id41529003238747" role="paragraph" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> <bascode> - <paragraph role="bascode" id="par_id41529003225918" xml-lang="en-US" localize="false">Sub ShowElementNames(</paragraph> - <paragraph role="bascode" id="par_id321529005373289" xml-lang="en-US" localize="false">oLocElements() as Object,</paragraph> - <paragraph role="bascode" id="par_id1001529005296415" xml-lang="en-US" localize="false">Optional sFiltername as String)</paragraph> + <paragraph role="bascode" id="par_id41529003225918" localize="false">Sub ShowElementNames(</paragraph> + <paragraph role="bascode" id="par_id321529005373289" localize="false">oLocElements() as Object,</paragraph> + <paragraph role="bascode" id="par_id1001529005296415" localize="false">Optional sFiltername as String)</paragraph> </bascode> - <h3 id="hd_id581529003295045" xml-lang="en-US" localize="false">ShowSupportedServiceNames</h3> - <paragraph id="par_id851529003295045" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the supported servicenames of an object, with the </paragraph> - <paragraph id="par_id301529003401893" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <h3 id="hd_id581529003295045" localize="false">ShowSupportedServiceNames</h3> + <paragraph id="par_id851529003295045" role="paragraph" localize="false">' Retrieves all the supported servicenames of an object, with the </paragraph> + <paragraph id="par_id301529003401893" role="paragraph" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> <bascode> - <paragraph role="bascode" id="par_id801529003393056" xml-lang="en-US" localize="false">Sub ShowSupportedServiceNames(</paragraph> - <paragraph role="bascode" id="par_id101529005392934" xml-lang="en-US" localize="false">oLocObject as Object,</paragraph> - <paragraph role="bascode" id="par_id661529005271095" xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph> + <paragraph role="bascode" id="par_id801529003393056" localize="false">Sub ShowSupportedServiceNames(</paragraph> + <paragraph role="bascode" id="par_id101529005392934" localize="false">oLocObject as Object,</paragraph> + <paragraph role="bascode" id="par_id661529005271095" localize="false">Optional sFilterName as String)</paragraph> </bascode> - <h3 id="hd_id831529003429502" xml-lang="en-US" localize="false">ShowAvailableServiceNames</h3> - <paragraph id="par_id401529003494638" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the available Servicenames of an object, with the</paragraph> - <paragraph id="par_id801529003504707" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <h3 id="hd_id831529003429502" localize="false">ShowAvailableServiceNames</h3> + <paragraph id="par_id401529003494638" role="paragraph" localize="false">' Retrieves all the available Servicenames of an object, with the</paragraph> + <paragraph id="par_id801529003504707" role="paragraph" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> <bascode> - <paragraph role="bascode" id="par_id981529005231465" xml-lang="en-US" localize="false">Sub ShowAvailableServiceNames(</paragraph> - <paragraph role="bascode" id="par_id251529005237648" xml-lang="en-US" localize="false">oLocObject as Object, </paragraph> - <paragraph role="bascode" id="par_id721529005247098" xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph> + <paragraph role="bascode" id="par_id981529005231465" localize="false">Sub ShowAvailableServiceNames(</paragraph> + <paragraph role="bascode" id="par_id251529005237648" localize="false">oLocObject as Object, </paragraph> + <paragraph role="bascode" id="par_id721529005247098" localize="false">Optional sFilterName as String)</paragraph> </bascode> - <h3 id="hd_id591529003562090" xml-lang="en-US" localize="false">ShowCommands</h3> + <h3 id="hd_id591529003562090" localize="false">ShowCommands</h3> <bascode> - <paragraph id="par_id791529003562091" role="bascode" xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph> + <paragraph id="par_id791529003562091" role="bascode" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph> </bascode> - <h3 id="hd_id881529003602892" xml-lang="en-US" localize="false">ProtectCurrentSheets</h3> + <h3 id="hd_id881529003602892" localize="false">ProtectCurrentSheets</h3> <bascode> - <paragraph id="par_id531529003602892" role="bascode" xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph> + <paragraph id="par_id531529003602892" role="bascode" localize="false">Sub ProtectCurrentSheets()</paragraph> </bascode> - <h3 id="hd_id691529003635074" xml-lang="en-US" localize="false">FillDocument</h3> + <h3 id="hd_id691529003635074" localize="false">FillDocument</h3> <bascode> - <paragraph id="par_id371529003635074" role="bascode" xml-lang="en-US" localize="false">Sub FillDocument()</paragraph> + <paragraph id="par_id371529003635074" role="bascode" localize="false">Sub FillDocument()</paragraph> </bascode> </section> - <bookmark xml-lang="en-US" branch="index" id="bm_id131529062501888"> + <bookmark branch="index" id="bm_id131529062501888"> <bookmark_value>BASIC Tools library;ListBox module</bookmark_value> </bookmark> <section id="listbox_module"> <h2 id="hd_id11529005753099"><item type="literal">ListBox</item> Module</h2> - <paragraph role="paragraph" id="par_id381529064415052" xml-lang="en-US">Functions and subroutines for handling ListBox elements.</paragraph> + <paragraph role="paragraph" id="par_id381529064415052">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 branch="index" id="bm_id571529062538621"> <bookmark_value>BASIC Tools library;Misc module</bookmark_value> </bookmark> <section id="misc_module"> <h2 id="hd_id341529005758494"><item type="literal">Misc</item> Module</h2> - <paragraph role="paragraph" id="par_id681529064596175" xml-lang="en-US">Miscellaneous functions and subroutines.</paragraph> - <h3 id="hd_id801529006604779" xml-lang="en-US" localize="false">RegisterNewDataSource</h3> + <paragraph role="paragraph" id="par_id681529064596175">Miscellaneous functions and subroutines.</paragraph> + <h3 id="hd_id801529006604779" localize="false">RegisterNewDataSource</h3> <bascode> - <paragraph role="bascode" id="par_id851529006689297" xml-lang="en-US" localize="false">Function RegisterNewDataSource(</paragraph> - <paragraph role="bascode" id="par_id471529006695330" xml-lang="en-US" localize="false">DSName as String, </paragraph> - <paragraph role="bascode" id="par_id671529006700462" xml-lang="en-US" localize="false">PropertyList(), </paragraph> - <paragraph role="bascode" id="par_id821529006705849" xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph> - <paragraph role="bascode" id="par_id321529061768930" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + <paragraph role="bascode" id="par_id851529006689297" localize="false">Function RegisterNewDataSource(</paragraph> + <paragraph role="bascode" id="par_id471529006695330" localize="false">DSName as String, </paragraph> + <paragraph role="bascode" id="par_id671529006700462" localize="false">PropertyList(), </paragraph> + <paragraph role="bascode" id="par_id821529006705849" localize="false">Optional DriverProperties() </paragraph> + <paragraph role="bascode" id="par_id321529061768930" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> </bascode> - <h3 id="hd_id501529006725521" xml-lang="en-US" localize="false">ConnecttoDatabase</h3> + <h3 id="hd_id501529006725521" localize="false">ConnecttoDatabase</h3> <bascode> - <paragraph role="bascode" id="par_id771529006782954" xml-lang="en-US" localize="false">Function ConnecttoDatabase(</paragraph> - <paragraph role="bascode" id="par_id31529006789644" xml-lang="en-US" localize="false">DSName as String, </paragraph> - <paragraph role="bascode" id="par_id421529006794640" xml-lang="en-US" localize="false">UserID as String, </paragraph> - <paragraph role="bascode" id="par_id381529006799623" xml-lang="en-US" localize="false">Password as String, </paragraph> - <paragraph role="bascode" id="par_id641529006805066" xml-lang="en-US" localize="false">Optional Propertylist(), </paragraph> - <paragraph role="bascode" id="par_id201529006810077" xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph> - <paragraph role="bascode" id="par_id11529061810188" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + <paragraph role="bascode" id="par_id771529006782954" localize="false">Function ConnecttoDatabase(</paragraph> + <paragraph role="bascode" id="par_id31529006789644" localize="false">DSName as String, </paragraph> + <paragraph role="bascode" id="par_id421529006794640" localize="false">UserID as String, </paragraph> + <paragraph role="bascode" id="par_id381529006799623" localize="false">Password as String, </paragraph> + <paragraph role="bascode" id="par_id641529006805066" localize="false">Optional Propertylist(), </paragraph> + <paragraph role="bascode" id="par_id201529006810077" localize="false">Optional DriverProperties() </paragraph> + <paragraph role="bascode" id="par_id11529061810188" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> </bascode> - <h3 id="hd_id411529006832985" xml-lang="en-US" localize="false">GetStarOfficeLocale</h3> + <h3 id="hd_id411529006832985" localize="false">GetStarOfficeLocale</h3> <bascode> - <paragraph id="par_id451529006832985" role="bascode" xml-lang="en-US" localize="false">Function GetStarOfficeLocale() </paragraph> - <paragraph role="bascode" id="par_id761529061825013" xml-lang="en-US" localize="false">as New com.sun.star.lang.Locale</paragraph> + <paragraph id="par_id451529006832985" role="bascode" localize="false">Function GetStarOfficeLocale() </paragraph> + <paragraph role="bascode" id="par_id761529061825013" localize="false">as New com.sun.star.lang.Locale</paragraph> </bascode> - <h3 id="hd_id361529006902547" xml-lang="en-US" localize="false">GetRegistryKeyContent</h3> + <h3 id="hd_id361529006902547" localize="false">GetRegistryKeyContent</h3> <bascode> - <paragraph role="bascode" id="par_id391529006938605" xml-lang="en-US" localize="false">Function GetRegistryKeyContent(</paragraph> - <paragraph role="bascode" id="par_id881529006944515" xml-lang="en-US" localize="false">sKeyName as string, </paragraph> - <paragraph role="bascode" id="par_id711529006950283" xml-lang="en-US" localize="false">Optional bforUpdate as Boolean)</paragraph> + <paragraph role="bascode" id="par_id391529006938605" localize="false">Function GetRegistryKeyContent(</paragraph> + <paragraph role="bascode" id="par_id881529006944515" localize="false">sKeyName as string, </paragraph> + <paragraph role="bascode" id="par_id711529006950283" localize="false">Optional bforUpdate as Boolean)</paragraph> </bascode> - <h3 id="hd_id851529006965105" xml-lang="en-US" localize="false">GetProductname</h3> + <h4 id="hd_id481688911437449">Example</h4> <bascode> - <paragraph id="par_id451529006965105" role="bascode" xml-lang="en-US" localize="false">Function GetProductname() as String</paragraph> + <paragraph role="bascode" id="par_id151688911451438" localize="false">Sub GetUserData()</paragraph> + <paragraph role="bascode" id="par_id221688911474607" localize="false">BasicLibraries.LoadLibrary("Tools")</paragraph> + <paragraph role="bascode" id="par_id581688911479556" localize="false">Dim oData As Object</paragraph> + <paragraph role="bascode" id="par_id361688911484981" localize="false">oData = GetRegistryKeyContent("org.openoffice.UserProfile/Data", True)</paragraph> + <paragraph role="bascode" id="par_id181688911494350" localize="false">MsgBox oData.givenname & " " & oData.sn</paragraph> + <paragraph role="bascode" id="par_id611688911499172" localize="false">End Sub</paragraph> </bascode> - <h3 id="hd_id771529007007439" xml-lang="en-US" localize="false">OpenDocument</h3> - <paragraph id="par_id821529007072253" role="paragraph" localize="false" xml-lang="en-US">' Opens a Document, checks beforehand, whether it has to be loaded or whether it is already on the desktop. If the parameter bDisposable is set to False then the returned document should not be disposed afterwards, because it is already opened.</paragraph> + <h3 id="hd_id851529006965105" localize="false">GetProductname</h3> <bascode> - <paragraph role="bascode" id="par_id991529007104165" xml-lang="en-US" localize="false">Function OpenDocument(</paragraph> - <paragraph role="bascode" id="par_id191529007110562" xml-lang="en-US" localize="false">DocPath as String, </paragraph> - <paragraph role="bascode" id="par_id851529007118783" xml-lang="en-US" localize="false">Args(), </paragraph> - <paragraph role="bascode" id="par_id691529007123485" xml-lang="en-US" localize="false">Optional bDisposable as Boolean)</paragraph> + <paragraph id="par_id451529006965105" role="bascode" localize="false">Function GetProductname() as String</paragraph> </bascode> - <h3 id="hd_id481529007130534" xml-lang="en-US" localize="false">TaskonDesktop</h3> + <h3 id="hd_id771529007007439" localize="false">OpenDocument</h3> + <paragraph id="par_id821529007072253" role="paragraph" localize="false">' Opens a Document, checks beforehand, whether it has to be loaded or whether it is already on the desktop. If the parameter bDisposable is set to False then the returned document should not be disposed afterwards, because it is already opened.</paragraph> <bascode> - <paragraph id="par_id911529007130534" role="bascode" xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph> + <paragraph role="bascode" id="par_id991529007104165" localize="false">Function OpenDocument(</paragraph> + <paragraph role="bascode" id="par_id191529007110562" localize="false">DocPath as String, </paragraph> + <paragraph role="bascode" id="par_id851529007118783" localize="false">Args(), </paragraph> + <paragraph role="bascode" id="par_id691529007123485" localize="false">Optional bDisposable as Boolean)</paragraph> </bascode> - <h3 id="hd_id201529007205755" xml-lang="en-US" localize="false">RetrieveFileName</h3> - <paragraph id="par_id81529007245965" role="paragraph" localize="false" xml-lang="en-US">' Retrieves a FileName out of a StarOffice-Document.</paragraph> + <h3 id="hd_id481529007130534" localize="false">TaskonDesktop</h3> <bascode> - <paragraph role="bascode" id="par_id881529007259806" xml-lang="en-US" localize="false">Function RetrieveFileName(LocDoc as Object)</paragraph> + <paragraph id="par_id911529007130534" role="bascode" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph> </bascode> - <h3 id="hd_id121529007269721" xml-lang="en-US" localize="false">GetPathSettings</h3> - <paragraph id="par_id801529007338550" role="paragraph" localize="false" xml-lang="en-US">' Gets a special configured PathSetting.</paragraph> + <h3 id="hd_id201529007205755" localize="false">RetrieveFileName</h3> + <paragraph id="par_id81529007245965" role="paragraph" localize="false">' Retrieves a FileName out of a StarOffice-Document.</paragraph> <bascode> - <paragraph role="bascode" id="par_id971529007353940" xml-lang="en-US" localize="false">Function GetPathSettings(</paragraph> - <paragraph role="bascode" id="par_id401529007360579" xml-lang="en-US" localize="false">sPathType as String,</paragraph> - <paragraph role="bascode" id="par_id741529007366892" xml-lang="en-US" localize="false">Optional bshowall as Boolean, </paragraph> - <paragraph role="bascode" id="par_id841529007371792" xml-lang="en-US" localize="false">Optional ListIndex as integer) as String</paragraph> + <paragraph role="bascode" id="par_id881529007259806" localize="false">Function RetrieveFileName(LocDoc as Object)</paragraph> </bascode> - <h3 id="hd_id571529007381828" xml-lang="en-US" localize="false">GetOfficeSubPath</h3> - <paragraph id="par_id761529007616982" role="paragraph" localize="false" xml-lang="en-US">' Gets the fully qualified path to a subdirectory of the Template Directory, e. g. with the parameter "wizard/bitmap". The parameter must be passed over in Url-scription. The return-Value is in Urlscription.</paragraph> + <h3 id="hd_id121529007269721" localize="false">GetPathSettings</h3> + <paragraph id="par_id801529007338550" role="paragraph" localize="false">' Gets a special configured PathSetting.</paragraph> <bascode> - <paragraph role="bascode" id="par_id981529007639916" xml-lang="en-US" localize="false">Function GetOfficeSubPath(</paragraph> - <paragraph role="bascode" id="par_id21529007645780" xml-lang="en-US" localize="false">sOfficePath as String, </paragraph> - <paragraph role="bascode" id="par_id201529007651880" xml-lang="en-US" localize="false">ByVal sSubDir as String)</paragraph> + <paragraph role="bascode" id="par_id971529007353940" localize="false">Function GetPathSettings(</paragraph> + <paragraph role="bascode" id="par_id401529007360579" localize="false">sPathType as String,</paragraph> + <paragraph role="bascode" id="par_id741529007366892" localize="false">Optional bshowall as Boolean, </paragraph> + <paragraph role="bascode" id="par_id841529007371792" localize="false">Optional ListIndex as integer) as String</paragraph> </bascode> - <h3 id="hd_id591529007658281" xml-lang="en-US" localize="false">ShowNoOfficePathError</h3> + <h3 id="hd_id571529007381828" localize="false">GetOfficeSubPath</h3> + <paragraph id="par_id761529007616982" role="paragraph" localize="false">' Gets the fully qualified path to a subdirectory of the Template Directory, e. g. with the parameter "wizard/bitmap". The parameter must be passed over in Url-scription. The return-Value is in Urlscription.</paragraph> <bascode> - <paragraph id="par_id511529007658281" role="bascode" xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph> + <paragraph role="bascode" id="par_id981529007639916" localize="false">Function GetOfficeSubPath(</paragraph> + <paragraph role="bascode" id="par_id21529007645780" localize="false">sOfficePath as String, </paragraph> + <paragraph role="bascode" id="par_id201529007651880" localize="false">ByVal sSubDir as String)</paragraph> </bascode> - <h3 id="hd_id431529007692356" xml-lang="en-US" localize="false">InitResources</h3> + <h3 id="hd_id591529007658281" localize="false">ShowNoOfficePathError</h3> <bascode> - <paragraph id="par_id991529007692356" role="bascode" xml-lang="en-US" localize="false">Function InitResources(</paragraph> - <paragraph role="bascode" id="par_id651529007767824" xml-lang="en-US" localize="false">Description, </paragraph> - <paragraph role="bascode" id="par_id401529007773380" xml-lang="en-US" localize="false">ShortDescription as String) as boolean</paragraph> + <paragraph id="par_id511529007658281" role="bascode" localize="false">Sub ShowNoOfficePathError() </paragraph> </bascode> - <h3 id="hd_id611529007790857" xml-lang="en-US" localize="false">GetResText</h3> + <h3 id="hd_id431529007692356" localize="false">InitResources</h3> <bascode> - <paragraph id="par_id331529007790857" role="bascode" xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As string</paragraph> + <paragraph id="par_id991529007692356" role="bascode" localize="false">Function InitResources(</paragraph> + <paragraph role="bascode" id="par_id651529007767824" localize="false">Description, </paragraph> + <paragraph role="bascode" id="par_id401529007773380" localize="false">ShortDescription as String) as boolean</paragraph> </bascode> - <h3 id="hd_id971529007839780" xml-lang="en-US" localize="false">CutPathView</h3> + <h3 id="hd_id611529007790857" localize="false">GetResText</h3> <bascode> - <paragraph role="bascode" id="par_id91529007882196" xml-lang="en-US" localize="false">Function CutPathView(</paragraph> - <paragraph role="bascode" id="par_id211529007888525" xml-lang="en-US" localize="false">sDocUrl as String, </paragraph> - <paragraph role="bascode" id="par_id361529007894202" xml-lang="en-US" localize="false">Optional PathLen as Integer)</paragraph> + <paragraph id="par_id331529007790857" role="bascode" localize="false">Function GetResText( nID as integer ) As string</paragraph> </bascode> - <h3 id="hd_id51529007902118" xml-lang="en-US" localize="false">DeleteInputCells</h3> - <paragraph id="par_id311529007997114" role="paragraph" localize="false" xml-lang="en-US">' Deletes the content of all cells that are softformatted according to the 'InputStyleName'.</paragraph> + <h3 id="hd_id971529007839780" localize="false">CutPathView</h3> <bascode> - <paragraph role="bascode" id="par_id111529008013953" xml-lang="en-US" localize="false">Sub DeleteInputCells(</paragraph> - <paragraph role="bascode" id="par_id731529008019208" xml-lang="en-US" localize="false">oSheet as Object, </paragraph> - <paragraph role="bascode" id="par_id881529008025944" xml-lang="en-US" localize="false">InputStyleName as String)</paragraph> + <paragraph role="bascode" id="par_id91529007882196" localize="false">Function CutPathView(</paragraph> + <paragraph role="bascode" id="par_id211529007888525" localize="false">sDocUrl as String, </paragraph> + <paragraph role="bascode" id="par_id361529007894202" localize="false">Optional PathLen as Integer)</paragraph> </bascode> - <h3 id="hd_id881529008035409" xml-lang="en-US" localize="false">ChangeValueofRange</h3> - <paragraph id="par_id261529008090521" role="paragraph" xml-lang="en-US" localize="false">' Inserts a certain String to all cells of a Range that is passed over either as an object or as the RangeName.</paragraph> + <h3 id="hd_id51529007902118" localize="false">DeleteInputCells</h3> + <paragraph id="par_id311529007997114" role="paragraph" localize="false">' Deletes the content of all cells that are softformatted according to the 'InputStyleName'.</paragraph> <bascode> - <paragraph role="bascode" id="par_id231529008110214" xml-lang="en-US" localize="false">Sub ChangeValueofRange(</paragraph> - <paragraph role="bascode" id="par_id401529008116727" xml-lang="en-US" localize="false">oSheet as Object, </paragraph> - <paragraph role="bascode" id="par_id211529008122524" xml-lang="en-US" localize="false">Range, </paragraph> - <paragraph role="bascode" id="par_id91529008128202" xml-lang="en-US" localize="false">ReplaceValue, </paragraph> - <paragraph role="bascode" id="par_id671529008133554" xml-lang="en-US" localize="false">Optional StyleName as String)</paragraph> + <paragraph role="bascode" id="par_id111529008013953" localize="false">Sub DeleteInputCells(</paragraph> + <paragraph role="bascode" id="par_id731529008019208" localize="false">oSheet as Object, </paragraph> + <paragraph role="bascode" id="par_id881529008025944" localize="false">InputStyleName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547275154" xml-lang="en-US" localize="false">ReplaceRangeValues</h3> + <h3 id="hd_id881529008035409" localize="false">ChangeValueofRange</h3> + <paragraph id="par_id261529008090521" role="paragraph" localize="false">' Inserts a certain String to all cells of a Range that is passed over either as an object or as the RangeName.</paragraph> <bascode> - <paragraph 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> + <paragraph role="bascode" id="par_id231529008110214" localize="false">Sub ChangeValueofRange(</paragraph> + <paragraph role="bascode" id="par_id401529008116727" localize="false">oSheet as Object, </paragraph> + <paragraph role="bascode" id="par_id211529008122524" localize="false">Range, </paragraph> + <paragraph role="bascode" id="par_id91529008128202" localize="false">ReplaceValue, </paragraph> + <paragraph role="bascode" id="par_id671529008133554" localize="false">Optional StyleName as String)</paragraph> </bascode> - <h3 id="hd_id06142018054727953" xml-lang="en-US" localize="false">GetValueofCellbyName</h3> - <paragraph id="par_id061420180547271480" role="paragraph" xml-lang="en-US" localize="false">' Returns the Value of the first cell of a Range.</paragraph> + <h3 id="hd_id061420180547275154" localize="false">ReplaceRangeValues</h3> <bascode> - <paragraph id="par_id061420180547275293" role="bascode" localize="false" xml-lang="en-US">Function GetValueofCellbyName(</paragraph> - <paragraph id="par_id061420180547274365" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547272143" role="bascode" localize="false" xml-lang="en-US">sCellName as String)</paragraph> + <paragraph id="par_id061420180547275639" role="bascode" localize="false">Sub ReplaceRangeValues(</paragraph> + <paragraph id="par_id061420180547279527" role="bascode" localize="false">oRange as Object, </paragraph> + <paragraph id="par_id061420180547277" role="bascode" localize="false">ReplaceValue)</paragraph> </bascode> - <h3 id="hd_id061420180547273177" xml-lang="en-US" localize="false">DuplicateRow</h3> + <h3 id="hd_id06142018054727953" localize="false">GetValueofCellbyName</h3> + <paragraph id="par_id061420180547271480" role="paragraph" localize="false">' Returns the Value of the first cell of a Range.</paragraph> <bascode> - <paragraph id="par_id061420180547278695" role="bascode" localize="false" xml-lang="en-US">Function DuplicateRow(</paragraph> - <paragraph id="par_id061420180547271430" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547271882" role="bascode" localize="false" xml-lang="en-US">RangeName as String)</paragraph> + <paragraph id="par_id061420180547275293" role="bascode" localize="false">Function GetValueofCellbyName(</paragraph> + <paragraph id="par_id061420180547274365" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547272143" role="bascode" localize="false">sCellName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547271951" xml-lang="en-US" localize="false">GetStringofCellbyName</h3> - <paragraph id="par_id061420180547275159" role="paragraph" xml-lang="en-US" localize="false">' Returns the String of the first cell of a Range.</paragraph> + <h3 id="hd_id061420180547273177" localize="false">DuplicateRow</h3> <bascode> - <paragraph id="par_id061420180547277611" role="bascode" localize="false" xml-lang="en-US">Function GetStringofCellbyName(</paragraph> - <paragraph id="par_id061420180547271853" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547277036" role="bascode" localize="false" xml-lang="en-US">sCellName as String)</paragraph> + <paragraph id="par_id061420180547278695" role="bascode" localize="false">Function DuplicateRow(</paragraph> + <paragraph id="par_id061420180547271430" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547271882" role="bascode" localize="false">RangeName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547271528" xml-lang="en-US" localize="false">GetCellByName</h3> - <paragraph id="par_id061420180547271588" role="paragraph" xml-lang="en-US" localize="false">' Returns a named Cell</paragraph> + <h3 id="hd_id061420180547271951" localize="false">GetStringofCellbyName</h3> + <paragraph id="par_id061420180547275159" role="paragraph" localize="false">' Returns the String of the first cell of a Range.</paragraph> <bascode> - <paragraph id="par_id061420180547278497" role="bascode" localize="false" xml-lang="en-US">Function GetCellByName(</paragraph> - <paragraph id="par_id061420180547284593" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547285667" role="bascode" localize="false" xml-lang="en-US">sCellName as String) as Object</paragraph> + <paragraph id="par_id061420180547277611" role="bascode" localize="false">Function GetStringofCellbyName(</paragraph> + <paragraph id="par_id061420180547271853" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547277036" role="bascode" localize="false">sCellName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547288062" xml-lang="en-US" localize="false">ChangeCellValue</h3> - <paragraph id="par_id061420180547288384" role="paragraph" xml-lang="en-US" localize="false">' Changes the numeric Value of a cell by transmitting the String of the numeric Value.</paragraph> + <h3 id="hd_id061420180547271528" localize="false">GetCellByName</h3> + <paragraph id="par_id061420180547271588" role="paragraph" localize="false">' Returns a named Cell</paragraph> <bascode> - <paragraph id="par_id061420180547287291" role="bascode" localize="false" xml-lang="en-US">Sub ChangeCellValue(</paragraph> - <paragraph id="par_id061420180547287421" role="bascode" localize="false" xml-lang="en-US">oCell as Object, </paragraph> - <paragraph id="par_id061420180547283866" role="bascode" localize="false" xml-lang="en-US">ValueString as String)</paragraph> + <paragraph id="par_id061420180547278497" role="bascode" localize="false">Function GetCellByName(</paragraph> + <paragraph id="par_id061420180547284593" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547285667" role="bascode" localize="false">sCellName as String) as Object</paragraph> </bascode> - <h3 id="hd_id061420180547283259" xml-lang="en-US" localize="false">GetDocumentType</h3> + <h3 id="hd_id061420180547288062" localize="false">ChangeCellValue</h3> + <paragraph id="par_id061420180547288384" role="paragraph" localize="false">' Changes the numeric Value of a cell by transmitting the String of the numeric Value.</paragraph> <bascode> - <paragraph id="par_id061420180547286797" role="bascode" localize="false" xml-lang="en-US">Function GetDocumentType(oDocument)</paragraph> + <paragraph id="par_id061420180547287291" role="bascode" localize="false">Sub ChangeCellValue(</paragraph> + <paragraph id="par_id061420180547287421" role="bascode" localize="false">oCell as Object, </paragraph> + <paragraph id="par_id061420180547283866" role="bascode" localize="false">ValueString as String)</paragraph> </bascode> - <h3 id="hd_id061420180547288146" xml-lang="en-US" localize="false">GetNumberFormatType</h3> + <h3 id="hd_id061420180547283259" localize="false">GetDocumentType</h3> <bascode> - <paragraph id="par_id061420180547285276" role="bascode" localize="false" xml-lang="en-US">Function GetNumberFormatType(</paragraph> - <paragraph id="par_id061420180547282526" role="bascode" localize="false" xml-lang="en-US">oDocFormats, </paragraph> - <paragraph id="par_id061420180547285804" role="bascode" localize="false" xml-lang="en-US">oFormatObject as Object) as Integer</paragraph> + <paragraph id="par_id061420180547286797" role="bascode" localize="false">Function GetDocumentType(oDocument)</paragraph> </bascode> - <h3 id="hd_id061420180547282335" xml-lang="en-US" localize="false">ProtectSheets</h3> + <h3 id="hd_id061420180547288146" localize="false">GetNumberFormatType</h3> <bascode> - <paragraph id="par_id061420180547283563" role="bascode" localize="false" xml-lang="en-US">Sub ProtectSheets(Optional oSheets as Object)</paragraph> + <paragraph id="par_id061420180547285276" role="bascode" localize="false">Function GetNumberFormatType(</paragraph> + <paragraph id="par_id061420180547282526" role="bascode" localize="false">oDocFormats, </paragraph> + <paragraph id="par_id061420180547285804" role="bascode" localize="false">oFormatObject as Object) as Integer</paragraph> </bascode> - <h3 id="hd_id061420180547285130" xml-lang="en-US" localize="false">UnprotectSheets</h3> + <h3 id="hd_id061420180547282335" localize="false">ProtectSheets</h3> <bascode> - <paragraph id="par_id061420180547289761" role="bascode" localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional oSheets as Object)</paragraph> + <paragraph id="par_id061420180547283563" role="bascode" localize="false">Sub ProtectSheets(Optional oSheets as Object)</paragraph> </bascode> - <h3 id="hd_id061420180547284142" xml-lang="en-US" localize="false">GetRowIndex</h3> + <h3 id="hd_id061420180547285130" localize="false">UnprotectSheets</h3> <bascode> - <paragraph id="par_id061420180547284432" role="bascode" localize="false" xml-lang="en-US">Function GetRowIndex(</paragraph> - <paragraph id="par_id061420180547284492" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547288316" role="bascode" localize="false" xml-lang="en-US">RowName as String)</paragraph> + <paragraph id="par_id061420180547289761" role="bascode" localize="false">Sub UnprotectSheets(Optional oSheets as Object)</paragraph> </bascode> - <h3 id="hd_id061420180547284556" xml-lang="en-US" localize="false">GetColumnIndex</h3> + <h3 id="hd_id061420180547284142" localize="false">GetRowIndex</h3> <bascode> - <paragraph id="par_id061420180547285812" role="bascode" localize="false" xml-lang="en-US">Function GetColumnIndex(</paragraph> - <paragraph id="par_id061420180547287653" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061420180547285010" role="bascode" localize="false" xml-lang="en-US">ColName as String)</paragraph> + <paragraph id="par_id061420180547284432" role="bascode" localize="false">Function GetRowIndex(</paragraph> + <paragraph id="par_id061420180547284492" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547288316" role="bascode" localize="false">RowName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547285141" xml-lang="en-US" localize="false">CopySheetbyName</h3> + <h3 id="hd_id061420180547284556" localize="false">GetColumnIndex</h3> <bascode> - <paragraph id="par_id061420180547284524" role="bascode" localize="false" xml-lang="en-US">Function CopySheetbyName(</paragraph> - <paragraph id="par_id061420180547286144" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> - <paragraph id="par_id061420180547289148" role="bascode" localize="false" xml-lang="en-US">OldName as String, </paragraph> - <paragraph id="par_id061420180547287225" role="bascode" localize="false" xml-lang="en-US">NewName as String, </paragraph> - <paragraph id="par_id061420180547299943" role="bascode" localize="false" xml-lang="en-US">DestPos as Integer) as Object</paragraph> + <paragraph id="par_id061420180547285812" role="bascode" localize="false">Function GetColumnIndex(</paragraph> + <paragraph id="par_id061420180547287653" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547285010" role="bascode" localize="false">ColName as String)</paragraph> </bascode> - <h3 id="hd_id0614201805472944" xml-lang="en-US" localize="false">ToggleWindow</h3> - <paragraph id="par_id061420180547292068" role="paragraph" xml-lang="en-US" localize="false">' Dis-or enables a Window and adjusts the mousepointer accordingly</paragraph> + <h3 id="hd_id061420180547285141" localize="false">CopySheetbyName</h3> <bascode> - <paragraph id="par_id061420180547296555" role="bascode" localize="false" xml-lang="en-US">Sub ToggleWindow(bDoEnable as Boolean)</paragraph> + <paragraph id="par_id061420180547284524" role="bascode" localize="false">Function CopySheetbyName(</paragraph> + <paragraph id="par_id061420180547286144" role="bascode" localize="false">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547289148" role="bascode" localize="false">OldName as String, </paragraph> + <paragraph id="par_id061420180547287225" role="bascode" localize="false">NewName as String, </paragraph> + <paragraph id="par_id061420180547299943" role="bascode" localize="false">DestPos as Integer) as Object</paragraph> </bascode> - <h3 id="hd_id061420180547294361" xml-lang="en-US" localize="false">CheckNewSheetname</h3> + <h3 id="hd_id0614201805472944" localize="false">ToggleWindow</h3> + <paragraph id="par_id061420180547292068" role="paragraph" localize="false">' Dis-or enables a Window and adjusts the mousepointer accordingly</paragraph> <bascode> - <paragraph id="par_id061420180547292565" role="bascode" localize="false" xml-lang="en-US">Function CheckNewSheetname(</paragraph> - <paragraph id="par_id061420180547293242" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> - <paragraph id="par_id061420180547297240" role="bascode" localize="false" xml-lang="en-US">Sheetname as String, </paragraph> - <paragraph id="par_id061420180547294328" role="bascode" localize="false" xml-lang="en-US">Optional oLocale) as String</paragraph> + <paragraph id="par_id061420180547296555" role="bascode" localize="false">Sub ToggleWindow(bDoEnable as Boolean)</paragraph> </bascode> - <h3 id="hd_id061420180547298278" xml-lang="en-US" localize="false">AddNewSheetName</h3> + <h3 id="hd_id061420180547294361" localize="false">CheckNewSheetname</h3> <bascode> - <paragraph id="par_id061420180547299974" role="bascode" localize="false" xml-lang="en-US">Sub AddNewSheetName(</paragraph> - <paragraph id="par_id061420180547292009" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> - <paragraph id="par_id061420180547293223" role="bascode" localize="false" xml-lang="en-US">ByVal SheetName as String)</paragraph> + <paragraph id="par_id061420180547292565" role="bascode" localize="false">Function CheckNewSheetname(</paragraph> + <paragraph id="par_id061420180547293242" role="bascode" localize="false">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547297240" role="bascode" localize="false">Sheetname as String, </paragraph> + <paragraph id="par_id061420180547294328" role="bascode" localize="false">Optional oLocale) as String</paragraph> </bascode> - <h3 id="hd_id061420180547293964" xml-lang="en-US" localize="false">GetSheetIndex</h3> + <h3 id="hd_id061420180547298278" localize="false">AddNewSheetName</h3> <bascode> - <paragraph id="par_id06142018054729713" role="bascode" localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as Integer</paragraph> + <paragraph id="par_id061420180547299974" role="bascode" localize="false">Sub AddNewSheetName(</paragraph> + <paragraph id="par_id061420180547292009" role="bascode" localize="false">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547293223" role="bascode" localize="false">ByVal SheetName as String)</paragraph> </bascode> - <h3 id="hd_id061420180547298034" xml-lang="en-US" localize="false">GetLastUsedRow</h3> + <h3 id="hd_id061420180547293964" localize="false">GetSheetIndex</h3> <bascode> - <paragraph id="par_id061420180547299520" role="bascode" localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph> + <paragraph id="par_id06142018054729713" role="bascode" localize="false">Function GetSheetIndex(oSheets, sName) as Integer</paragraph> </bascode> - <h3 id="hd_id061420180547294665" xml-lang="en-US" localize="false">ModifyBorderLineWidth</h3> - <paragraph id="par_id061420180547295117" role="paragraph" xml-lang="en-US" localize="false">' Note To set a one lined frame you have to set the inner width to 0 In the API all Units that refer to pt-Heights are "1/100mm" The convert factor from 1pt to 1/100 mm is approximately 35 </paragraph> + <h3 id="hd_id061420180547298034" localize="false">GetLastUsedRow</h3> <bascode> - <paragraph id="par_id061420180547295225" role="bascode" localize="false" xml-lang="en-US">Function ModifyBorderLineWidth(</paragraph> - <paragraph id="par_id061420180547292084" role="bascode" localize="false" xml-lang="en-US">ByVal oStyleBorder, </paragraph> - <paragraph id="par_id061420180547292560" role="bascode" localize="false" xml-lang="en-US">iInnerLineWidth as Integer, </paragraph> - <paragraph id="par_id061420180547295476" role="bascode" localize="false" xml-lang="en-US">iOuterLineWidth as Integer)</paragraph> + <paragraph id="par_id061420180547299520" role="bascode" localize="false">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph> </bascode> - <h3 id="hd_id06142018054729303" xml-lang="en-US" localize="false">AttachBasicMacroToEvent</h3> + <h3 id="hd_id061420180547294665" localize="false">ModifyBorderLineWidth</h3> + <paragraph id="par_id061420180547295117" role="paragraph" localize="false">' Note To set a one lined frame you have to set the inner width to 0 In the API all Units that refer to pt-Heights are "1/100mm" The convert factor from 1pt to 1/100 mm is approximately 35 </paragraph> <bascode> - <paragraph id="par_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> + <paragraph id="par_id061420180547295225" role="bascode" localize="false">Function ModifyBorderLineWidth(</paragraph> + <paragraph id="par_id061420180547292084" role="bascode" localize="false">ByVal oStyleBorder, </paragraph> + <paragraph id="par_id061420180547292560" role="bascode" localize="false">iInnerLineWidth as Integer, </paragraph> + <paragraph id="par_id061420180547295476" role="bascode" localize="false">iOuterLineWidth as Integer)</paragraph> </bascode> - <h3 id="hd_id061420180547308735" xml-lang="en-US" localize="false">ModifyPropertyValue</h3> + <h3 id="hd_id06142018054729303" localize="false">AttachBasicMacroToEvent</h3> <bascode> - <paragraph id="par_id061420180547306755" role="bascode" localize="false" xml-lang="en-US">Function ModifyPropertyValue(</paragraph> - <paragraph id="par_id061420180547304617" role="bascode" localize="false" xml-lang="en-US">oContent() as New com.sun.star.beans.PropertyValue, </paragraph> - <paragraph id="par_id061420180547301558" role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph> - <paragraph role="bascode" id="par_id941529062083471" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + <paragraph id="par_id061420180547296417" role="bascode" localize="false">Sub AttachBasicMacroToEvent(</paragraph> + <paragraph id="par_id061420180547292774" role="bascode" localize="false">oDocument as Object, </paragraph> + <paragraph id="par_id061420180547291074" role="bascode" localize="false">EventName as String, </paragraph> + <paragraph id="par_id061420180547293426" role="bascode" localize="false">SubPath as String)</paragraph> </bascode> - <h3 id="hd_id06142018054730528" xml-lang="en-US" localize="false">GetPropertyValueIndex</h3> + <h3 id="hd_id061420180547308735" localize="false">ModifyPropertyValue</h3> <bascode> - <paragraph id="par_id061420180547304668" role="bascode" localize="false" xml-lang="en-US">Function GetPropertyValueIndex(</paragraph> - <paragraph id="par_id061420180547302428" role="bascode" localize="false" xml-lang="en-US">SearchName as String, </paragraph> - <paragraph id="par_id061420180547306561" role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph> - <paragraph role="bascode" id="par_id971529062111510" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue ) as Integer</paragraph> + <paragraph id="par_id061420180547306755" role="bascode" localize="false">Function ModifyPropertyValue(</paragraph> + <paragraph id="par_id061420180547304617" role="bascode" localize="false">oContent() as New com.sun.star.beans.PropertyValue, </paragraph> + <paragraph id="par_id061420180547301558" role="bascode" localize="false">TargetProperties() </paragraph> + <paragraph role="bascode" id="par_id941529062083471" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> </bascode> - <h3 id="hd_id061420180547305379" xml-lang="en-US" localize="false">DispatchSlot</h3> + <h3 id="hd_id06142018054730528" localize="false">GetPropertyValueIndex</h3> <bascode> - <paragraph id="par_id061420180547302087" role="bascode" localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as Integer)</paragraph> + <paragraph id="par_id061420180547304668" role="bascode" localize="false">Function GetPropertyValueIndex(</paragraph> + <paragraph id="par_id061420180547302428" role="bascode" localize="false">SearchName as String, </paragraph> + <paragraph id="par_id061420180547306561" role="bascode" localize="false">TargetProperties() </paragraph> + <paragraph role="bascode" id="par_id971529062111510" localize="false">as New com.sun.star.beans.PropertyValue ) as Integer</paragraph> </bascode> - <h3 id="hd_id061420180547308065" xml-lang="en-US" localize="false">IsFatOffice</h3> - <paragraph id="par_id061420180547306757" role="paragraph" xml-lang="en-US" localize="false">'returns the type of the office application FatOffice = 0, WebTop = 1 This routine has to be changed if the Product Name is being changed! </paragraph> + <h3 id="hd_id061420180547305379" localize="false">DispatchSlot</h3> <bascode> - <paragraph id="par_id061420180547302561" role="bascode" localize="false" xml-lang="en-US">Function IsFatOffice() As Boolean</paragraph> + <paragraph id="par_id061420180547302087" role="bascode" localize="false">Sub DispatchSlot(SlotID as Integer)</paragraph> </bascode> - <h3 id="hd_id06142018054730408" xml-lang="en-US" localize="false">GetLocale</h3> + <h3 id="hd_id061420180547308065" localize="false">IsFatOffice</h3> + <paragraph id="par_id061420180547306757" role="paragraph" localize="false">'returns the type of the office application FatOffice = 0, WebTop = 1 This routine has to be changed if the Product Name is being changed! </paragraph> <bascode> - <paragraph id="par_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> + <paragraph id="par_id061420180547302561" role="bascode" localize="false">Function IsFatOffice() As Boolean</paragraph> </bascode> - <h3 id="hd_id061420180547305357" xml-lang="en-US" localize="false">ToggleDesignMode</h3> + <h3 id="hd_id06142018054730408" localize="false">GetLocale</h3> <bascode> - <paragraph id="par_id061420180547301559" role="bascode" localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument as Object)</paragraph> + <paragraph id="par_id061420180547306751" role="bascode" localize="false">Function GetLocale(</paragraph> + <paragraph id="par_id061420180547302792" role="bascode" localize="false">sLanguage as String, </paragraph> + <paragraph id="par_id061420180547307976" role="bascode" localize="false">sCountry as String)</paragraph> </bascode> - <h3 id="hd_id061420180547301521" xml-lang="en-US" localize="false">isHighContrast</h3> + <h3 id="hd_id061420180547305357" localize="false">ToggleDesignMode</h3> <bascode> - <paragraph id="par_id061420180547302307" role="bascode" localize="false" xml-lang="en-US">Function isHighContrast(oPeer as Object)</paragraph> + <paragraph id="par_id061420180547301559" role="bascode" localize="false">Sub ToggleDesignMode(oDocument as Object)</paragraph> </bascode> - <h3 id="hd_id061420180547302524" xml-lang="en-US" localize="false">CreateNewDocument</h3> + <h3 id="hd_id061420180547301521" localize="false">isHighContrast</h3> <bascode> - <paragraph id="par_id061420180547302408" role="bascode" localize="false" xml-lang="en-US">Function CreateNewDocument(</paragraph> - <paragraph id="par_id061420180547306406" role="bascode" localize="false" xml-lang="en-US">sType as String, </paragraph> - <paragraph id="par_id061420180547302638" role="bascode" localize="false" xml-lang="en-US">Optional sAddMsg as String) as Object</paragraph> + <paragraph id="par_id061420180547302307" role="bascode" localize="false">Function isHighContrast(oPeer as Object)</paragraph> </bascode> - <h3 id="hd_id061420180547306821" xml-lang="en-US" localize="false">DisposeDocument</h3> - <paragraph id="par_id061420180547308844" role="paragraph" localize="false" xml-lang="en-US">' This Sub has been used in order to ensure that after disposing a document from the backing window it is returned to the backing window, so the office won't be closed</paragraph> + <h3 id="hd_id061420180547302524" localize="false">CreateNewDocument</h3> <bascode> - <paragraph id="par_id061420180547301077" role="bascode" localize="false" xml-lang="en-US">Sub DisposeDocument(oDocument as Object)</paragraph> + <paragraph id="par_id061420180547302408" role="bascode" localize="false">Function CreateNewDocument(</paragraph> + <paragraph id="par_id061420180547306406" role="bascode" localize="false">sType as String, </paragraph> + <paragraph id="par_id061420180547302638" role="bascode" localize="false">Optional sAddMsg as String) as Object</paragraph> </bascode> - <h3 id="hd_id061420180547316190" xml-lang="en-US" localize="false">CalIsLeapYear</h3> - <paragraph id="par_id061420180547311590" role="paragraph" xml-lang="en-US" localize="false">'Function to calculate if the year is a leap year</paragraph> + <h3 id="hd_id061420180547306821" localize="false">DisposeDocument</h3> + <paragraph id="par_id061420180547308844" role="paragraph" localize="false">' This Sub has been used in order to ensure that after disposing a document from the backing window it is returned to the backing window, so the office won't be closed</paragraph> <bascode> - <paragraph id="par_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> + <paragraph id="par_id061420180547301077" role="bascode" localize="false">Sub DisposeDocument(oDocument as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547316190" localize="false">CalIsLeapYear</h3> + <paragraph id="par_id061420180547311590" role="paragraph" localize="false">'Function to calculate if the year is a leap year</paragraph> + <bascode> + <paragraph id="par_id061420180547311314" role="bascode" localize="false">Function CalIsLeapYear(</paragraph> + <paragraph role="bascode" id="par_id401529062200648" localize="false">ByVal iYear as Integer) as Boolean</paragraph> </bascode> </section> - <bookmark xml-lang="en-US" branch="index" id="bm_id21529062611375"> + <bookmark branch="index" id="bm_id21529062611375"> <bookmark_value>BASIC Tools library;ModuleControl module</bookmark_value> </bookmark> <section id="modulecontrols_module"> <h2 id="hd_id451529005764422"><item type="literal">ModuleControls</item> Module</h2> - <paragraph role="paragraph" id="par_id841529064645990" xml-lang="en-US">Functions and subroutines for module control.</paragraph> - <h3 id="hd_id061520180728405758" xml-lang="en-US" localize="false">GetControlShape</h3> - <paragraph id="par_id061520180728404186" role="paragraph" localize="false" xml-lang="en-US">' Gets the Shape of a Control( e. g. to reset the size or Position of the control</paragraph> - <paragraph id="par_id061520180728405899" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> - <paragraph id="par_id061520180728401929" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> - <paragraph id="par_id061520180728406561" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <paragraph role="paragraph" id="par_id841529064645990">Functions and subroutines for module control.</paragraph> + <h3 id="hd_id061520180728405758" localize="false">GetControlShape</h3> + <paragraph id="par_id061520180728404186" role="paragraph" localize="false">' Gets the Shape of a Control( e. g. to reset the size or Position of the control</paragraph> + <paragraph id="par_id061520180728405899" role="paragraph" localize="false">' Parameters:</paragraph> + <paragraph id="par_id061520180728401929" role="paragraph" localize="false">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728406561" role="paragraph" localize="false">' 'CName' is the Name of the Control</paragraph> <bascode> - <paragraph id="par_id061520180728403658" role="bascode" localize="false" xml-lang="en-US">Function GetControlShape(</paragraph> - <paragraph role="bascode" id="par_id731529060754496" xml-lang="en-US" localize="false">oContainer as Object,</paragraph> - <paragraph role="bascode" id="par_id571529060764136" xml-lang="en-US" localize="false">CName as String)</paragraph> + <paragraph id="par_id061520180728403658" role="bascode" localize="false">Function GetControlShape(</paragraph> + <paragraph role="bascode" id="par_id731529060754496" localize="false">oContainer as Object,</paragraph> + <paragraph role="bascode" id="par_id571529060764136" localize="false">CName as String)</paragraph> </bascode> - <h3 id="hd_id061520180728402154" xml-lang="en-US" localize="false">getControlView</h3> - <paragraph id="par_id061520180728406447" role="paragraph" localize="false" xml-lang="en-US">' Returns the View of a Control</paragraph> - <paragraph id="par_id061520180728405250" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> - <paragraph id="par_id061520180728407354" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> - <paragraph id="par_id061520180728407546" role="paragraph" localize="false" xml-lang="en-US">' The 'oController' is always directly attached to the Document</paragraph> - <paragraph id="par_id061520180728401894" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <h3 id="hd_id061520180728402154" localize="false">getControlView</h3> + <paragraph id="par_id061520180728406447" role="paragraph" localize="false">' Returns the View of a Control</paragraph> + <paragraph id="par_id061520180728405250" role="paragraph" localize="false">' Parameters:</paragraph> + <paragraph id="par_id061520180728407354" role="paragraph" localize="false">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728407546" role="paragraph" localize="false">' The 'oController' is always directly attached to the Document</paragraph> + <paragraph id="par_id061520180728401894" role="paragraph" localize="false">' 'CName' is the Name of the Control</paragraph> <bascode> - <paragraph id="par_id061520180728405914" role="bascode" localize="false" xml-lang="en-US">Function getControlView(</paragraph> - <paragraph role="bascode" id="par_id431529060800677" xml-lang="en-US" localize="false">oContainer , </paragraph> - <paragraph role="bascode" id="par_id471529060805433" xml-lang="en-US" localize="false">oController as Object, </paragraph> - <paragraph role="bascode" id="par_id501529060820866" xml-lang="en-US" localize="false">CName as String) as Object</paragraph> + <paragraph id="par_id061520180728405914" role="bascode" localize="false">Function getControlView(</paragraph> + <paragraph role="bascode" id="par_id431529060800677" localize="false">oContainer , </paragraph> + <paragraph role="bascode" id="par_id471529060805433" localize="false">oController as Object, </paragraph> + <paragraph role="bascode" id="par_id501529060820866" localize="false">CName as String) as Object</paragraph> </bascode> - <h3 id="hd_id061520180728409398" xml-lang="en-US" localize="false">DisposeControl</h3> - <paragraph id="par_id061520180728406445" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> - <paragraph id="par_id061520180728405024" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> - <paragraph id="par_id061520180728403834" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <h3 id="hd_id061520180728409398" localize="false">DisposeControl</h3> + <paragraph id="par_id061520180728406445" role="paragraph" localize="false">' Parameters:</paragraph> + <paragraph id="par_id061520180728405024" role="paragraph" localize="false">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728403834" role="paragraph" localize="false">' 'CName' is the Name of the Control</paragraph> <bascode> - <paragraph id="par_id061520180728406007" role="bascode" localize="false" xml-lang="en-US">Function DisposeControl(</paragraph> - <paragraph role="bascode" id="par_id161529060860526" xml-lang="en-US" localize="false">oContainer as Object, </paragraph> - <paragraph role="bascode" id="par_id311529060865820" xml-lang="en-US" localize="false">CName as String) as Boolean</paragraph> + <paragraph id="par_id061520180728406007" role="bascode" localize="false">Function DisposeControl(</paragraph> + <paragraph role="bascode" id="par_id161529060860526" localize="false">oContainer as Object, </paragraph> + <paragraph role="bascode" id="par_id311529060865820" localize="false">CName as String) as Boolean</paragraph> </bascode> - <h3 id="hd_id061520180728401986" xml-lang="en-US" localize="false">GetControlGroupModel</h3> - <paragraph id="par_id061520180728404727" role="paragraph" localize="false" xml-lang="en-US">' Returns a sequence of a group of controls like option buttons or checkboxes</paragraph> - <paragraph id="par_id061520180728404702" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> - <paragraph id="par_id061520180728402498" role="paragraph" localize="false" xml-lang="en-US">' 'sGroupName' is the Name of the Controlgroup</paragraph> + <h3 id="hd_id061520180728401986" localize="false">GetControlGroupModel</h3> + <paragraph id="par_id061520180728404727" role="paragraph" localize="false">' Returns a sequence of a group of controls like option buttons or checkboxes</paragraph> + <paragraph id="par_id061520180728404702" role="paragraph" localize="false">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728402498" role="paragraph" localize="false">' 'sGroupName' is the Name of the Controlgroup</paragraph> <bascode> - <paragraph id="par_id061520180728405097" role="bascode" localize="false" xml-lang="en-US">Function GetControlGroupModel(</paragraph> - <paragraph role="bascode" id="par_id271529060883844" xml-lang="en-US" localize="false">oContainer as Object, </paragraph> - <paragraph role="bascode" id="par_id131529060888366" xml-lang="en-US" localize="false">sGroupName as String )</paragraph> + <paragraph id="par_id061520180728405097" role="bascode" localize="false">Function GetControlGroupModel(</paragraph> + <paragraph role="bascode" id="par_id271529060883844" localize="false">oContainer as Object, </paragraph> + <paragraph role="bascode" id="par_id131529060888366" localize="false">sGroupName as String )</paragraph> </bascode> - <h3 id="hd_id061520180728404995" xml-lang="en-US" localize="false">GetRefValue</h3> - <paragraph id="par_id06152018072840427" role="paragraph" localize="false" xml-lang="en-US">' Returns the Referencevalue of a group of e.g. option buttons or check boxes</paragraph> - <paragraph id="par_id061520180728401645" role="paragraph" localize="false" xml-lang="en-US">' 'oControlGroup' is a sequence of the Control objects</paragraph> + <h3 id="hd_id061520180728404995" localize="false">GetRefValue</h3> + <paragraph id="par_id06152018072840427" role="paragraph" localize="false">' Returns the Referencevalue of a group of e.g. option buttons or check boxes</paragraph> + <paragraph id="par_id061520180728401645" role="paragraph" localize="false">' 'oControlGroup' is a sequence of the Control objects</paragraph> <bascode> - <paragraph id="par_id061520180728405216" role="bascode" localize="false" xml-lang="en-US">Function GetRefValue(</paragraph> - <paragraph role="bascode" id="par_id311529060906785" xml-lang="en-US" localize="false">oControlGroup() as Object)</paragraph> + <paragraph id="par_id061520180728405216" role="bascode" localize="false">Function GetRefValue(</paragraph> + <paragraph role="bascode" id="par_id311529060906785" localize="false">oControlGroup() as Object)</paragraph> </bascode> - <h3 id="hd_id06152018072841458" xml-lang="en-US" localize="false">GetRefValueOfControlGroup</h3> + <h3 id="hd_id06152018072841458" localize="false">GetRefValueOfControlGroup</h3> <bascode> - <paragraph id="par_id061520180728415365" role="bascode" localize="false" xml-lang="en-US">Function GetRefValueOfControlGroup(</paragraph> - <paragraph id="par_id061520180728416461" role="bascode" localize="false" xml-lang="en-US">oContainer as Object, </paragraph> - <paragraph id="par_id061520180728413768" role="bascode" localize="false" xml-lang="en-US">GroupName as String)</paragraph> + <paragraph id="par_id061520180728415365" role="bascode" localize="false">Function GetRefValueOfControlGroup(</paragraph> + <paragraph id="par_id061520180728416461" role="bascode" localize="false">oContainer as Object, </paragraph> + <paragraph id="par_id061520180728413768" role="bascode" localize="false">GroupName as String)</paragraph> </bascode> - <h3 id="hd_id061520180728416653" xml-lang="en-US" localize="false">GetOptionGroupValue</h3> + <h3 id="hd_id061520180728416653" localize="false">GetOptionGroupValue</h3> <bascode> - <paragraph id="par_id061520180728411484" role="bascode" localize="false" xml-lang="en-US">Function GetOptionGroupValue(</paragraph> - <paragraph id="par_id061520180728412653" role="bascode" localize="false" xml-lang="en-US">oContainer as Object, </paragraph> - <paragraph id="par_id061520180728413045" role="bascode" localize="false" xml-lang="en-US">OptGroupName as String) as Boolean</paragraph> + <paragraph id="par_id061520180728411484" role="bascode" localize="false">Function GetOptionGroupValue(</paragraph> + <paragraph id="par_id061520180728412653" role="bascode" localize="false">oContainer as Object, </paragraph> + <paragraph id="par_id061520180728413045" role="bascode" localize="false">OptGroupName as String) as Boolean</paragraph> </bascode> - <h3 id="hd_id061520180728419761" xml-lang="en-US" localize="false">WriteOptValueToCell</h3> + <h3 id="hd_id061520180728419761" localize="false">WriteOptValueToCell</h3> <bascode> - <paragraph id="par_id061520180728414297" role="bascode" localize="false" xml-lang="en-US">Function WriteOptValueToCell(</paragraph> - <paragraph id="par_id061520180728414871" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> - <paragraph id="par_id061520180728416273" role="bascode" localize="false" xml-lang="en-US">OptGroupName as String, </paragraph> - <paragraph id="par_id061520180728411892" role="bascode" localize="false" xml-lang="en-US">iCol as Integer, </paragraph> - <paragraph id="par_id061520180728411133" role="bascode" localize="false" xml-lang="en-US">iRow as Integer) as Boolean</paragraph> + <paragraph id="par_id061520180728414297" role="bascode" localize="false">Function WriteOptValueToCell(</paragraph> + <paragraph id="par_id061520180728414871" role="bascode" localize="false">oSheet as Object, </paragraph> + <paragraph id="par_id061520180728416273" role="bascode" localize="false">OptGroupName as String, </paragraph> + <paragraph id="par_id061520180728411892" role="bascode" localize="false">iCol as Integer, </paragraph> + <paragraph id="par_id061520180728411133" role="bascode" localize="false">iRow as Integer) as Boolean</paragraph> </bascode> - <h3 id="hd_id061520180728411084" xml-lang="en-US" localize="false">LoadDialog</h3> + <h3 id="hd_id061520180728411084" localize="false">LoadDialog</h3> <bascode> - <paragraph id="par_id061520180728416215" role="bascode" localize="false" xml-lang="en-US">Function LoadDialog(</paragraph> - <paragraph id="par_id061520180728415374" role="bascode" localize="false" xml-lang="en-US">Libname as String, </paragraph> - <paragraph id="par_id061520180728411337" role="bascode" localize="false" xml-lang="en-US">DialogName as String, </paragraph> - <paragraph id="par_id061520180728412212" role="bascode" localize="false" xml-lang="en-US">Optional oLibContainer)</paragraph> + <paragraph id="par_id061520180728416215" role="bascode" localize="false">Function LoadDialog(</paragraph> + <paragraph id="par_id061520180728415374" role="bascode" localize="false">Libname as String, </paragraph> + <paragraph id="par_id061520180728411337" role="bascode" localize="false">DialogName as String, </paragraph> + <paragraph id="par_id061520180728412212" role="bascode" localize="false">Optional oLibContainer)</paragraph> </bascode> <paragraph role="paragraph" id="par_id261558858921700">Refer to <link href="text/sbasic/guide/show_dialog.xhp#show_dialog">Opening a Dialog with Basic</link> for an example of LoadDialog function.</paragraph> - <h3 id="hd_id061520180728417528" xml-lang="en-US" localize="false">GetFolderName</h3> + <h3 id="hd_id061520180728417528" localize="false">GetFolderName</h3> <bascode> - <paragraph id="par_id061520180728414273" role="bascode" localize="false" xml-lang="en-US">Sub GetFolderName(oRefModel as Object)</paragraph> + <paragraph id="par_id061520180728414273" role="bascode" localize="false">Sub GetFolderName(oRefModel as Object)</paragraph> </bascode> - <h3 id="hd_id061520180728412942" xml-lang="en-US" localize="false">GetFileName</h3> + <h3 id="hd_id061520180728412942" localize="false">GetFileName</h3> <bascode> - <paragraph id="par_id061520180728416696" role="bascode" localize="false" xml-lang="en-US">Sub GetFileName(</paragraph> - <paragraph id="par_id061520180728417082" role="bascode" localize="false" xml-lang="en-US">oRefModel as Object, </paragraph> - <paragraph id="par_id061520180728418718" role="bascode" localize="false" xml-lang="en-US">Filternames())</paragraph> + <paragraph id="par_id061520180728416696" role="bascode" localize="false">Sub GetFileName(</paragraph> + <paragraph id="par_id061520180728417082" role="bascode" localize="false">oRefModel as Object, </paragraph> + <paragraph id="par_id061520180728418718" role="bascode" localize="false">Filternames())</paragraph> </bascode> - <h3 id="hd_id061520180728414394" xml-lang="en-US" localize="false">StoreDocument</h3> + <h3 id="hd_id061520180728414394" localize="false">StoreDocument</h3> <bascode> - <paragraph id="par_id061520180728415594" role="bascode" localize="false" xml-lang="en-US">Function StoreDocument(</paragraph> - <paragraph id="par_id061520180728417685" role="bascode" localize="false" xml-lang="en-US">oDocument as Object, </paragraph> - <paragraph id="par_id061520180728416184" role="bascode" localize="false" xml-lang="en-US">FilterNames() as String, </paragraph> - <paragraph id="par_id061520180728414290" role="bascode" localize="false" xml-lang="en-US">DefaultName as String, </paragraph> - <paragraph id="par_id061520180728419279" role="bascode" localize="false" xml-lang="en-US">DisplayDirectory as String, </paragraph> - <paragraph id="par_id061520180728421914" role="bascode" localize="false" xml-lang="en-US">Optional iAddProcedure as Integer) as String</paragraph> + <paragraph id="par_id061520180728415594" role="bascode" localize="false">Function StoreDocument(</paragraph> + <paragraph id="par_id061520180728417685" role="bascode" localize="false">oDocument as Object, </paragraph> + <paragraph id="par_id061520180728416184" role="bascode" localize="false">FilterNames() as String, </paragraph> + <paragraph id="par_id061520180728414290" role="bascode" localize="false">DefaultName as String, </paragraph> + <paragraph id="par_id061520180728419279" role="bascode" localize="false">DisplayDirectory as String, </paragraph> + <paragraph id="par_id061520180728421914" role="bascode" localize="false">Optional iAddProcedure as Integer) as String</paragraph> </bascode> - <h3 id="hd_id061520180728424363" xml-lang="en-US" localize="false">AddFiltersToDialog</h3> + <h3 id="hd_id061520180728424363" localize="false">AddFiltersToDialog</h3> <bascode> - <paragraph id="par_id061520180728429017" role="bascode" localize="false" xml-lang="en-US">Sub AddFiltersToDialog(</paragraph> - <paragraph id="par_id061520180728424454" role="bascode" localize="false" xml-lang="en-US">FilterNames() as String, </paragraph> - <paragraph id="par_id061520180728422747" role="bascode" localize="false" xml-lang="en-US">oDialog as Object)</paragraph> + <paragraph id="par_id061520180728429017" role="bascode" localize="false">Sub AddFiltersToDialog(</paragraph> + <paragraph id="par_id061520180728424454" role="bascode" localize="false">FilterNames() as String, </paragraph> + <paragraph id="par_id061520180728422747" role="bascode" localize="false">oDialog as Object)</paragraph> </bascode> - <h3 id="hd_id061520180728422388" xml-lang="en-US" localize="false">SwitchMousePointer</h3> + <h3 id="hd_id061520180728422388" localize="false">SwitchMousePointer</h3> <bascode> - <paragraph id="par_id0615201807284277" role="bascode" localize="false" xml-lang="en-US">Sub SwitchMousePointer(</paragraph> - <paragraph id="par_id061520180728421877" role="bascode" localize="false" xml-lang="en-US">oWindowPeer as Object, </paragraph> - <paragraph id="par_id061520180728429500" role="bascode" localize="false" xml-lang="en-US">bDoEnable as Boolean)</paragraph> + <paragraph id="par_id0615201807284277" role="bascode" localize="false">Sub SwitchMousePointer(</paragraph> + <paragraph id="par_id061520180728421877" role="bascode" localize="false">oWindowPeer as Object, </paragraph> + <paragraph id="par_id061520180728429500" role="bascode" localize="false">bDoEnable as Boolean)</paragraph> </bascode> - <h3 id="hd_id061520180728428854" xml-lang="en-US" localize="false">ShowOverwriteAllDialog</h3> + <h3 id="hd_id061520180728428854" localize="false">ShowOverwriteAllDialog</h3> <bascode> - <paragraph id="par_id061520180728427224" role="bascode" localize="false" xml-lang="en-US">Sub ShowOverwriteAllDialog(</paragraph> - <paragraph id="par_id06152018072842792" role="bascode" localize="false" xml-lang="en-US">FilePath as String, </paragraph> - <paragraph id="par_id061520180728429393" role="bascode" localize="false" xml-lang="en-US">sTitle as String)</paragraph> + <paragraph id="par_id061520180728427224" role="bascode" localize="false">Sub ShowOverwriteAllDialog(</paragraph> + <paragraph id="par_id06152018072842792" role="bascode" localize="false">FilePath as String, </paragraph> + <paragraph id="par_id061520180728429393" role="bascode" localize="false">sTitle as String)</paragraph> </bascode> - <h3 id="hd_id061520180728429649" xml-lang="en-US" localize="false">SetOVERWRITEToQuery</h3> + <h3 id="hd_id061520180728429649" localize="false">SetOVERWRITEToQuery</h3> <bascode> - <paragraph id="par_id061520180728429597" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToQuery()</paragraph> + <paragraph id="par_id061520180728429597" role="bascode" localize="false">Sub SetOVERWRITEToQuery()</paragraph> </bascode> - <h3 id="hd_id061520180728428255" xml-lang="en-US" localize="false">SetOVERWRITEToAlways</h3> + <h3 id="hd_id061520180728428255" localize="false">SetOVERWRITEToAlways</h3> <bascode> - <paragraph id="par_id061520180728424733" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToAlways()</paragraph> + <paragraph id="par_id061520180728424733" role="bascode" localize="false">Sub SetOVERWRITEToAlways()</paragraph> </bascode> - <h3 id="hd_id06152018072842702" xml-lang="en-US" localize="false">SetOVERWRITEToNever</h3> + <h3 id="hd_id06152018072842702" localize="false">SetOVERWRITEToNever</h3> <bascode> - <paragraph id="par_id061520180728429250" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToNever()</paragraph> + <paragraph id="par_id061520180728429250" role="bascode" localize="false">Sub SetOVERWRITEToNever()</paragraph> </bascode> </section> - <bookmark xml-lang="en-US" branch="index" id="bm_id271529062660965"> + <bookmark branch="index" id="bm_id271529062660965"> <bookmark_value>BASIC Tools library;Strings module</bookmark_value> </bookmark> <section id="strings_module"> <h2 id="hd_id461529005770576"><item type="literal">Strings</item> Module</h2> - <paragraph role="paragraph" id="par_id631529064722315" xml-lang="en-US">Advanced functions and subroutines for string manipulation.</paragraph> - <h3 id="hd_id061420180708276674" xml-lang="en-US" localize="false">ElimChar</h3> + <paragraph role="paragraph" id="par_id631529064722315">Advanced functions and subroutines for string manipulation.</paragraph> + <h3 id="hd_id061420180708276674" localize="false">ElimChar</h3> <bascode> - <paragraph id="par_id061420180708276186" role="bascode" localize="false" xml-lang="en-US">Function ElimChar(</paragraph> - <paragraph role="bascode" id="par_id551529060984480" xml-lang="en-US" localize="false">ByVal BigString as String, </paragraph> - <paragraph role="bascode" id="par_id871529060990727" xml-lang="en-US" localize="false">ElimArray() as String)</paragraph> + <paragraph id="par_id061420180708276186" role="bascode" localize="false">Function ElimChar(</paragraph> + <paragraph role="bascode" id="par_id551529060984480" localize="false">ByVal BigString as String, </paragraph> + <paragraph role="bascode" id="par_id871529060990727" localize="false">ElimArray() as String)</paragraph> </bascode> - <h3 id="hd_id061420180708279224" xml-lang="en-US" localize="false">DeleteStr</h3> - <paragraph id="par_id061420180708275363" role="paragraph" localize="false" xml-lang="en-US">' Deletes out of a String 'BigString' a possible Partstring 'CompString'</paragraph> + <h3 id="hd_id061420180708279224" localize="false">DeleteStr</h3> + <paragraph id="par_id061420180708275363" role="paragraph" localize="false">' Deletes out of a String 'BigString' a possible Partstring 'CompString'</paragraph> <bascode> - <paragraph id="par_id061420180708303146" role="bascode" localize="false" xml-lang="en-US">Function DeleteStr(</paragraph> - <paragraph id="par_id061420180708306296" role="bascode" localize="false" xml-lang="en-US">ByVal BigString,</paragraph> - <paragraph id="par_id061420180708301803" role="bascode" localize="false" xml-lang="en-US">CompString as String) as String</paragraph> - </bascode> - <h3 id="hd_id061420180708308611" xml-lang="en-US" localize="false">FindPartString</h3> - <paragraph id="par_id061420180708308479" role="paragraph" localize="false" xml-lang="en-US">' Finds a PartString, that is framed by the Strings 'Prestring' and 'PostString'</paragraph> - <bascode> - <paragraph id="par_id061420180708305815" role="bascode" localize="false" xml-lang="en-US">Function FindPartString(</paragraph> - <paragraph id="par_id061420180708307045" role="bascode" localize="false" xml-lang="en-US">BigString, </paragraph> - <paragraph id="par_id061420180708308079" role="bascode" localize="false" xml-lang="en-US">PreString, </paragraph> - <paragraph id="par_id061420180708302996" role="bascode" localize="false" xml-lang="en-US">PostString as String, </paragraph> - <paragraph id="par_id061420180708308715" role="bascode" localize="false" xml-lang="en-US">SearchPos as Integer) as String</paragraph> - </bascode> - <h3 id="hd_id06142018070830220" xml-lang="en-US" localize="false">PartStringInArray</h3> - <paragraph id="par_id061420180708302715" role="paragraph" localize="false" xml-lang="en-US">' Note iCompare = 0 (Binary comparison)</paragraph> - <paragraph id="par_id06142018070830615" role="paragraph" localize="false" xml-lang="en-US">' iCompare = 1 (Text comparison)</paragraph> - <bascode> - <paragraph id="par_id061420180708303506" role="bascode" localize="false" xml-lang="en-US">Function PartStringInArray(</paragraph> - <paragraph id="par_id06142018070830513" role="bascode" localize="false" xml-lang="en-US">BigArray(), </paragraph> - <paragraph id="par_id06142018070830983" role="bascode" localize="false" xml-lang="en-US">SearchString as String, </paragraph> - <paragraph id="par_id061420180708309182" role="bascode" localize="false" xml-lang="en-US">iCompare as Integer) as Integer</paragraph> - </bascode> - <h3 id="hd_id061420180708307208" xml-lang="en-US" localize="false">RTrimStr</h3> - <paragraph id="par_id061420180708304034" role="paragraph" localize="false" xml-lang="en-US">' Deletes the String 'SmallString' out of the String 'BigString'</paragraph> - <paragraph id="par_id06142018070830656" role="paragraph" localize="false" xml-lang="en-US">' in case SmallString's Position in BigString is right at the end</paragraph> - <bascode> - <paragraph id="par_id061420180708301129" role="bascode" localize="false" xml-lang="en-US">Function RtrimStr(</paragraph> - <paragraph id="par_id061420180708311705" role="bascode" localize="false" xml-lang="en-US">ByVal BigString, </paragraph> - <paragraph id="par_id061420180708312600" role="bascode" localize="false" xml-lang="en-US">SmallString as String) as String</paragraph> - </bascode> - <h3 id="hd_id061420180708314304" xml-lang="en-US" localize="false">LTRimChar</h3> - <paragraph id="par_id061420180708318862" role="paragraph" localize="false" xml-lang="en-US">' Deletes the Char 'CompChar' out of the String 'BigString'</paragraph> - <paragraph id="par_id061420180708319364" role="paragraph" localize="false" xml-lang="en-US">' in case CompChar's Position in BigString is right at the beginning</paragraph> - <bascode> - <paragraph id="par_id061420180708313231" role="bascode" localize="false" xml-lang="en-US">Function LTRimChar(</paragraph> - <paragraph id="par_id061420180708311887" role="bascode" localize="false" xml-lang="en-US">ByVal BigString as String,</paragraph> - <paragraph id="par_id061420180708313838" role="bascode" localize="false" xml-lang="en-US">CompChar as String) as String</paragraph> - </bascode> - <h3 id="hd_id061420180708314113" xml-lang="en-US" localize="false">ArrayOutOfString</h3> - <paragraph id="par_id061420180708315726" role="paragraph" localize="false" xml-lang="en-US">' Retrieves an Array out of a String.</paragraph> - <paragraph id="par_id061420180708316680" role="paragraph" localize="false" xml-lang="en-US">' The fields of the Array are separated by the parameter 'Separator', that is contained</paragraph> - <paragraph id="par_id06142018070831860" role="paragraph" localize="false" xml-lang="en-US">' in the Array</paragraph> - <paragraph id="par_id061420180708318872" role="paragraph" localize="false" xml-lang="en-US">' The Array MaxIndex delivers the highest Index of this Array</paragraph> - <bascode> - <paragraph id="par_id061420180708313417" role="bascode" localize="false" xml-lang="en-US">Function ArrayOutOfString(</paragraph> - <paragraph id="par_id061420180708317368" role="bascode" localize="false" xml-lang="en-US">BigString, </paragraph> - <paragraph id="par_id061420180708314602" role="bascode" localize="false" xml-lang="en-US">Separator as String, </paragraph> - <paragraph id="par_id061420180708311676" role="bascode" localize="false" xml-lang="en-US">Optional MaxIndex as Integer)</paragraph> - </bascode> - <h3 id="hd_id061420180708313207" xml-lang="en-US" localize="false">ClearArray</h3> - <paragraph id="par_id06142018070831823" role="paragraph" localize="false" xml-lang="en-US">' Deletes all fieldvalues in one-dimensional Array</paragraph> - <bascode> - <paragraph id="par_id061420180708315325" role="bascode" localize="false" xml-lang="en-US">Sub ClearArray(BigArray)</paragraph> - </bascode> - <h3 id="hd_id061420180708315939" xml-lang="en-US" localize="false">ClearMultiDimArray</h3> - <paragraph id="par_id061420180708319653" role="paragraph" localize="false" xml-lang="en-US">' Deletes all fieldvalues in a multidimensional Array</paragraph> + <paragraph id="par_id061420180708303146" role="bascode" localize="false">Function DeleteStr(</paragraph> + <paragraph id="par_id061420180708306296" role="bascode" localize="false">ByVal BigString,</paragraph> + <paragraph id="par_id061420180708301803" role="bascode" localize="false">CompString as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708308611" localize="false">FindPartString</h3> + <paragraph id="par_id061420180708308479" role="paragraph" localize="false">' Finds a PartString, that is framed by the Strings 'Prestring' and 'PostString'</paragraph> + <bascode> + <paragraph id="par_id061420180708305815" role="bascode" localize="false">Function FindPartString(</paragraph> + <paragraph id="par_id061420180708307045" role="bascode" localize="false">BigString, </paragraph> + <paragraph id="par_id061420180708308079" role="bascode" localize="false">PreString, </paragraph> + <paragraph id="par_id061420180708302996" role="bascode" localize="false">PostString as String, </paragraph> + <paragraph id="par_id061420180708308715" role="bascode" localize="false">SearchPos as Integer) as String</paragraph> + </bascode> + <h3 id="hd_id06142018070830220" localize="false">PartStringInArray</h3> + <paragraph id="par_id061420180708302715" role="paragraph" localize="false">' Note iCompare = 0 (Binary comparison)</paragraph> + <paragraph id="par_id06142018070830615" role="paragraph" localize="false">' iCompare = 1 (Text comparison)</paragraph> + <bascode> + <paragraph id="par_id061420180708303506" role="bascode" localize="false">Function PartStringInArray(</paragraph> + <paragraph id="par_id06142018070830513" role="bascode" localize="false">BigArray(), </paragraph> + <paragraph id="par_id06142018070830983" role="bascode" localize="false">SearchString as String, </paragraph> ... etc. - the rest is truncated