1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.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">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 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>
<note id="par_id901528999850603" localize="false"><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">Functions and subroutines for debugging Basic macros.</paragraph>
<h3 id="hd_id711529001004857" localize="false">ActivateReadOnlyFlag</h3>
<bascode>
<paragraph id="par_id251529001003857" role="bascode" localize="false">Sub ActivateReadOnlyFlag()</paragraph>
</bascode>
<h3 id="hd_id71529001663903" localize="false">DeactivateReadOnlyFlag</h3>
<bascode>
<paragraph id="par_id951529001706210" role="bascode" localize="false">Sub DeactivateReadOnlyFlag()</paragraph>
</bascode>
<h3 id="hd_id421529001727178" localize="false">SetBasicReadOnlyFlag</h3>
<bascode>
<paragraph id="par_id771529001755355" role="bascode" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph>
</bascode>
<h3 id="hd_id651529001954868" localize="false">WritedbgInfo</h3>
<bascode>
<paragraph id="par_id581529001865055" role="bascode" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph>
</bascode>
<h3 id="hd_id841529001994821" localize="false">WriteDbgString</h3>
<bascode>
<paragraph id="par_id171529002013434" role="bascode" localize="false">Sub WriteDbgString(LocString as String)</paragraph>
</bascode>
<h3 id="hd_id741529002099962" localize="false">ShowArray</h3>
<bascode>
<paragraph id="par_id261529002118559" role="bascode" localize="false">Sub ShowArray(LocArray())</paragraph>
</bascode>
<h3 id="hd_id321529002327444" localize="false">ShowPropertyValues</h3>
<bascode>
<paragraph id="par_id501529002327444" role="bascode" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph>
</bascode>
<h3 id="hd_id451529002368600" localize="false">ShowNameValuePair</h3>
<bascode>
<paragraph id="par_id321529002368600" role="bascode" localize="false">Sub ShowNameValuePair(Pair())</paragraph>
</bascode>
<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" 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" 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" 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" 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" 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" localize="false">ShowCommands</h3>
<bascode>
<paragraph id="par_id791529003562091" role="bascode" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph>
</bascode>
<h3 id="hd_id881529003602892" localize="false">ProtectCurrentSheets</h3>
<bascode>
<paragraph id="par_id531529003602892" role="bascode" localize="false">Sub ProtectCurrentSheets()</paragraph>
</bascode>
<h3 id="hd_id691529003635074" localize="false">FillDocument</h3>
<bascode>
<paragraph id="par_id371529003635074" role="bascode" localize="false">Sub FillDocument()</paragraph>
</bascode>
</section>
<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">Functions and subroutines for handling ListBox elements.</paragraph>
<embed href="text/shared/need_help.xhp#needhelp"/>
</section>
<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">Miscellaneous functions and subroutines.</paragraph>
<h3 id="hd_id801529006604779" localize="false">RegisterNewDataSource</h3>
<bascode>
<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" localize="false">ConnecttoDatabase</h3>
<bascode>
<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" localize="false">GetStarOfficeLocale</h3>
<bascode>
<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" localize="false">GetRegistryKeyContent</h3>
<bascode>
<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>
<h4 id="hd_id481688911437449">Example</h4>
<bascode>
<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_id851529006965105" localize="false">GetProductname</h3>
<bascode>
<paragraph id="par_id451529006965105" role="bascode" localize="false">Function GetProductname() as String</paragraph>
</bascode>
<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 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_id481529007130534" localize="false">TaskonDesktop</h3>
<bascode>
<paragraph id="par_id911529007130534" role="bascode" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph>
</bascode>
<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_id881529007259806" localize="false">Function RetrieveFileName(LocDoc as Object)</paragraph>
</bascode>
<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_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_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 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_id591529007658281" localize="false">ShowNoOfficePathError</h3>
<bascode>
<paragraph id="par_id511529007658281" role="bascode" localize="false">Sub ShowNoOfficePathError() </paragraph>
</bascode>
<h3 id="hd_id431529007692356" localize="false">InitResources</h3>
<bascode>
<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_id611529007790857" localize="false">GetResText</h3>
<bascode>
<paragraph id="par_id331529007790857" role="bascode" localize="false">Function GetResText( nID as integer ) As string</paragraph>
</bascode>
<h3 id="hd_id971529007839780" localize="false">CutPathView</h3>
<bascode>
<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_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_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_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 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_id061420180547275154" localize="false">ReplaceRangeValues</h3>
<bascode>
<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_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_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_id061420180547273177" localize="false">DuplicateRow</h3>
<bascode>
<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_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_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_id061420180547271528" localize="false">GetCellByName</h3>
<paragraph id="par_id061420180547271588" role="paragraph" localize="false">' Returns a named Cell</paragraph>
<bascode>
<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_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_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_id061420180547283259" localize="false">GetDocumentType</h3>
<bascode>
<paragraph id="par_id061420180547286797" role="bascode" localize="false">Function GetDocumentType(oDocument)</paragraph>
</bascode>
<h3 id="hd_id061420180547288146" localize="false">GetNumberFormatType</h3>
<bascode>
<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_id061420180547282335" localize="false">ProtectSheets</h3>
<bascode>
<paragraph id="par_id061420180547283563" role="bascode" localize="false">Sub ProtectSheets(Optional oSheets as Object)</paragraph>
</bascode>
<h3 id="hd_id061420180547285130" localize="false">UnprotectSheets</h3>
<bascode>
<paragraph id="par_id061420180547289761" role="bascode" localize="false">Sub UnprotectSheets(Optional oSheets as Object)</paragraph>
</bascode>
<h3 id="hd_id061420180547284142" localize="false">GetRowIndex</h3>
<bascode>
<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_id061420180547284556" localize="false">GetColumnIndex</h3>
<bascode>
<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_id061420180547285141" localize="false">CopySheetbyName</h3>
<bascode>
<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_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_id061420180547296555" role="bascode" localize="false">Sub ToggleWindow(bDoEnable as Boolean)</paragraph>
</bascode>
<h3 id="hd_id061420180547294361" localize="false">CheckNewSheetname</h3>
<bascode>
<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_id061420180547298278" localize="false">AddNewSheetName</h3>
<bascode>
<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_id061420180547293964" localize="false">GetSheetIndex</h3>
<bascode>
<paragraph id="par_id06142018054729713" role="bascode" localize="false">Function GetSheetIndex(oSheets, sName) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180547298034" localize="false">GetLastUsedRow</h3>
<bascode>
<paragraph id="par_id061420180547299520" role="bascode" localize="false">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph>
</bascode>
<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_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_id06142018054729303" localize="false">AttachBasicMacroToEvent</h3>
<bascode>
<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_id061420180547308735" localize="false">ModifyPropertyValue</h3>
<bascode>
<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_id06142018054730528" localize="false">GetPropertyValueIndex</h3>
<bascode>
<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_id061420180547305379" localize="false">DispatchSlot</h3>
<bascode>
<paragraph id="par_id061420180547302087" role="bascode" localize="false">Sub DispatchSlot(SlotID as Integer)</paragraph>
</bascode>
<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_id061420180547302561" role="bascode" localize="false">Function IsFatOffice() As Boolean</paragraph>
</bascode>
<h3 id="hd_id061420180547305357" localize="false">ToggleDesignMode</h3>
<bascode>
<paragraph id="par_id061420180547301559" role="bascode" localize="false">Sub ToggleDesignMode(oDocument as Object)</paragraph>
</bascode>
<h3 id="hd_id061420180547301521" localize="false">isHighContrast</h3>
<bascode>
<paragraph id="par_id061420180547302307" role="bascode" localize="false">Function isHighContrast(oPeer as Object)</paragraph>
</bascode>
<h3 id="hd_id061420180547302524" localize="false">CreateNewDocument</h3>
<bascode>
<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_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_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 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">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">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" 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">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" 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">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" 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">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" 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">Function GetRefValue(</paragraph>
<paragraph role="bascode" id="par_id311529060906785" localize="false">oControlGroup() as Object)</paragraph>
</bascode>
<h3 id="hd_id06152018072841458" localize="false">GetRefValueOfControlGroup</h3>
<bascode>
<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" localize="false">GetOptionGroupValue</h3>
<bascode>
<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" localize="false">WriteOptValueToCell</h3>
<bascode>
<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" localize="false">LoadDialog</h3>
<bascode>
<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" localize="false">GetFolderName</h3>
<bascode>
<paragraph id="par_id061520180728414273" role="bascode" localize="false">Sub GetFolderName(oRefModel as Object)</paragraph>
</bascode>
<h3 id="hd_id061520180728412942" localize="false">GetFileName</h3>
<bascode>
<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" localize="false">StoreDocument</h3>
<bascode>
<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" localize="false">AddFiltersToDialog</h3>
<bascode>
<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" localize="false">SwitchMousePointer</h3>
<bascode>
<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" localize="false">ShowOverwriteAllDialog</h3>
<bascode>
<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" localize="false">SetOVERWRITEToQuery</h3>
<bascode>
<paragraph id="par_id061520180728429597" role="bascode" localize="false">Sub SetOVERWRITEToQuery()</paragraph>
</bascode>
<h3 id="hd_id061520180728428255" localize="false">SetOVERWRITEToAlways</h3>
<bascode>
<paragraph id="par_id061520180728424733" role="bascode" localize="false">Sub SetOVERWRITEToAlways()</paragraph>
</bascode>
<h3 id="hd_id06152018072842702" localize="false">SetOVERWRITEToNever</h3>
<bascode>
<paragraph id="par_id061520180728429250" role="bascode" localize="false">Sub SetOVERWRITEToNever()</paragraph>
</bascode>
</section>
<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">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">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" 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">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>
<paragraph id="par_id061420180708309182" role="bascode" localize="false">iCompare as Integer) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180708307208" localize="false">RTrimStr</h3>
<paragraph id="par_id061420180708304034" role="paragraph" localize="false">' Deletes the String 'SmallString' out of the String 'BigString'</paragraph>
<paragraph id="par_id06142018070830656" role="paragraph" localize="false">' in case SmallString's Position in BigString is right at the end</paragraph>
<bascode>
<paragraph id="par_id061420180708301129" role="bascode" localize="false">Function RtrimStr(</paragraph>
<paragraph id="par_id061420180708311705" role="bascode" localize="false">ByVal BigString, </paragraph>
<paragraph id="par_id061420180708312600" role="bascode" localize="false">SmallString as String) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708314304" localize="false">LTRimChar</h3>
<paragraph id="par_id061420180708318862" role="paragraph" localize="false">' Deletes the Char 'CompChar' out of the String 'BigString'</paragraph>
<paragraph id="par_id061420180708319364" role="paragraph" localize="false">' in case CompChar's Position in BigString is right at the beginning</paragraph>
<bascode>
<paragraph id="par_id061420180708313231" role="bascode" localize="false">Function LTRimChar(</paragraph>
<paragraph id="par_id061420180708311887" role="bascode" localize="false">ByVal BigString as String,</paragraph>
<paragraph id="par_id061420180708313838" role="bascode" localize="false">CompChar as String) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708314113" localize="false">ArrayOutOfString</h3>
<paragraph id="par_id061420180708315726" role="paragraph" localize="false">' Retrieves an Array out of a String.</paragraph>
<paragraph id="par_id061420180708316680" role="paragraph" localize="false">' The fields of the Array are separated by the parameter 'Separator', that is contained</paragraph>
<paragraph id="par_id06142018070831860" role="paragraph" localize="false">' in the Array</paragraph>
<paragraph id="par_id061420180708318872" role="paragraph" localize="false">' The Array MaxIndex delivers the highest Index of this Array</paragraph>
<bascode>
<paragraph id="par_id061420180708313417" role="bascode" localize="false">Function ArrayOutOfString(</paragraph>
<paragraph id="par_id061420180708317368" role="bascode" localize="false">BigString, </paragraph>
<paragraph id="par_id061420180708314602" role="bascode" localize="false">Separator as String, </paragraph>
<paragraph id="par_id061420180708311676" role="bascode" localize="false">Optional MaxIndex as Integer)</paragraph>
</bascode>
<h3 id="hd_id061420180708313207" localize="false">ClearArray</h3>
<paragraph id="par_id06142018070831823" role="paragraph" localize="false">' Deletes all fieldvalues in one-dimensional Array</paragraph>
<bascode>
<paragraph id="par_id061420180708315325" role="bascode" localize="false">Sub ClearArray(BigArray)</paragraph>
</bascode>
<h3 id="hd_id061420180708315939" localize="false">ClearMultiDimArray</h3>
<paragraph id="par_id061420180708319653" role="paragraph" localize="false">' Deletes all fieldvalues in a multidimensional Array</paragraph>
<bascode>
<paragraph id="par_id061420180708314941" role="bascode" localize="false">Sub ClearMultiDimArray(</paragraph>
<paragraph role="bascode" id="par_id681529061123165" localize="false">BigArray,</paragraph>
<paragraph role="bascode" id="par_id981529061129190" localize="false">DimCount as integer)</paragraph>
</bascode>
<h3 id="hd_id0614201807083186" localize="false">FieldinArray</h3>
<paragraph id="par_id061420180708316541" role="paragraph" localize="false">' Checks if a Field (LocField) is already defined in an Array</paragraph>
<paragraph id="par_id061420180708319616" role="paragraph" localize="false">' Returns 'True' or 'False'</paragraph>
<bascode>
<paragraph id="par_id061420180708314166" role="bascode" localize="false">Function FieldinArray(</paragraph>
<paragraph id="par_id061420180708312267" role="bascode" localize="false">LocArray(), </paragraph>
<paragraph id="par_id061420180708312072" role="bascode" localize="false">MaxIndex as integer, </paragraph>
<paragraph id="par_id061420180708316376" role="bascode" localize="false">LocField as String) As Boolean</paragraph>
</bascode>
<h3 id="hd_id061420180708311512" localize="false">FieldinList</h3>
<paragraph id="par_id061420180708322561" role="paragraph" localize="false">' Checks if a Field (LocField) is already defined in an Array</paragraph>
<paragraph id="par_id061420180708329146" role="paragraph" localize="false">' Returns 'True' or 'False'</paragraph>
<bascode>
<paragraph id="par_id061420180708323174" role="bascode" localize="false">Function FieldinList(</paragraph>
<paragraph id="par_id061420180708323053" role="bascode" localize="false">LocField, </paragraph>
<paragraph id="par_id06142018070832420" role="bascode" localize="false">BigList()) As Boolean</paragraph>
</bascode>
<h3 id="hd_id061420180708323374" localize="false">IndexinArray</h3>
<paragraph id="par_id061420180708321488" role="paragraph" localize="false">' Retrieves the Index of the delivered String 'SearchString' in</paragraph>
<paragraph id="par_id061420180708323577" role="paragraph" localize="false">' the Array LocList()'</paragraph>
<bascode>
<paragraph id="par_id061420180708322202" role="bascode" localize="false">Function IndexinArray(</paragraph>
<paragraph id="par_id061420180708321376" role="bascode" localize="false">SearchString as String, </paragraph>
<paragraph id="par_id061420180708321330" role="bascode" localize="false">LocList()) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180708324642" localize="false">MultiArrayInListbox</h3>
<bascode>
<paragraph id="par_id061420180708326283" role="bascode" localize="false">Sub MultiArrayInListbox(</paragraph>
<paragraph id="par_id061420180708323785" role="bascode" localize="false">oDialog as Object, </paragraph>
<paragraph id="par_id061420180708325943" role="bascode" localize="false">ListboxName as String, </paragraph>
<paragraph id="par_id061420180708321048" role="bascode" localize="false">ValList(), </paragraph>
<paragraph id="par_id061420180708326030" role="bascode" localize="false">iDim as Integer)</paragraph>
</bascode>
<h3 id="hd_id061420180708325766" localize="false">StringInMultiArray</h3>
<paragraph id="par_id061420180708328772" role="paragraph" localize="false">' Searches for a String in a two-dimensional Array by querying all Searchindexes of the second dimension </paragraph>
<paragraph id="par_id061420180708324136" role="paragraph" localize="false">' and delivers the specific String of the ReturnIndex in the second dimension of the Searchlist()</paragraph>
<bascode>
<paragraph id="par_id061420180708326799" role="bascode" localize="false">Function StringInMultiArray(</paragraph>
<paragraph id="par_id061420180708324098" role="bascode" localize="false">SearchList(), </paragraph>
<paragraph id="par_id061420180708325264" role="bascode" localize="false">SearchString as String, </paragraph>
<paragraph id="par_id06142018070832793" role="bascode" localize="false">SearchIndex as Integer, </paragraph>
<paragraph id="par_id06142018070832221" role="bascode" localize="false">ReturnIndex as Integer, </paragraph>
<paragraph id="par_id061420180708329795" role="bascode" localize="false">Optional MaxIndex as Integer) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708327934" localize="false">GetIndexInMultiArray</h3>
<paragraph id="par_id06142018070832514" role="paragraph" localize="false">' Searches for a Value in multidimensial Array by querying all Searchindices of the passed dimension </paragraph>
<paragraph id="par_id061420180708329496" role="paragraph" localize="false">' and delivers the Index where it is found.</paragraph>
<bascode>
<paragraph id="par_id061420180708321937" role="bascode" localize="false">Function GetIndexInMultiArray(</paragraph>
<paragraph id="par_id061420180708323473" role="bascode" localize="false">SearchList(), </paragraph>
<paragraph id="par_id061420180708329899" role="bascode" localize="false">SearchValue, </paragraph>
<paragraph id="par_id061420180708339789" role="bascode" localize="false">SearchIndex as Integer) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180708336858" localize="false">GetIndexForPartStringinMultiArray</h3>
<paragraph id="par_id061420180708337261" role="paragraph" localize="false">' Searches for a Value in multidimensial Array by querying all Searchindices of the passed dimension </paragraph>
<paragraph id="par_id061420180708334301" role="paragraph" localize="false">' and delivers the Index where the Searchvalue is found as a part string</paragraph>
<bascode>
<paragraph id="par_id061420180708339583" role="bascode" localize="false">Function GetIndexForPartStringinMultiArray(</paragraph>
<paragraph id="par_id061420180708339052" role="bascode" localize="false">SearchList(), </paragraph>
<paragraph id="par_id061420180708338642" role="bascode" localize="false">SearchValue, </paragraph>
<paragraph id="par_id061420180708335373" role="bascode" localize="false">SearchIndex as Integer) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180708331666" localize="false">ArrayfromMultiArray</h3>
<bascode>
<paragraph id="par_id061420180708331057" role="bascode" localize="false">Function ArrayfromMultiArray(</paragraph>
<paragraph id="par_id061420180708333679" role="bascode" localize="false">MultiArray as String, </paragraph>
<paragraph id="par_id061420180708337806" role="bascode" localize="false">iDim as Integer)</paragraph>
</bascode>
<h3 id="hd_id061420180708335847" localize="false">ReplaceString</h3>
<paragraph id="par_id061420180708332382" role="paragraph" localize="false">' Replaces the string "OldReplace" through the String "NewReplace" in the String</paragraph>
<paragraph id="par_id061420180708334998" role="paragraph" localize="false">' 'BigString'</paragraph>
<bascode>
<paragraph id="par_id061420180708336799" role="bascode" localize="false">Function ReplaceString(</paragraph>
<paragraph id="par_id061420180708337582" role="bascode" localize="false">ByVal Bigstring, </paragraph>
<paragraph id="par_id0614201807083370" role="bascode" localize="false">NewReplace, </paragraph>
<paragraph id="par_id061420180708334572" role="bascode" localize="false">OldReplace as String) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708336841" localize="false">FindSecondValue</h3>
<paragraph id="par_id061420180708337504" role="paragraph" localize="false">' Retrieves the second value for a next to 'SearchString' in</paragraph>
<paragraph id="par_id061420180708335341" role="paragraph" localize="false">' a two-dimensional string-Array</paragraph>
<bascode>
<paragraph id="par_id061420180708337932" role="bascode" localize="false">Function FindSecondValue(</paragraph>
<paragraph role="bascode" id="par_id771529061274912" localize="false">SearchString as String, </paragraph>
<paragraph role="bascode" id="par_id91529061281985" localize="false">TwoDimList() as String ) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708339122" localize="false">Power</h3>
<paragraph id="par_id061420180708332948" role="paragraph" localize="false">' raises a base to a certain power</paragraph>
<bascode>
<paragraph id="par_id061420180708337053" role="bascode" localize="false">Function Power(</paragraph>
<paragraph id="par_id061420180708337160" role="bascode" localize="false">Basis as Double, </paragraph>
<paragraph id="par_id061420180708335666" role="bascode" localize="false">Exponent as Double) as Double</paragraph>
</bascode>
<h3 id="hd_id0614201807083362" localize="false">Round</h3>
<paragraph id="par_id061420180708349543" role="paragraph" localize="false">' rounds a Real to a given Number of Decimals</paragraph>
<bascode>
<paragraph id="par_id061420180708342039" role="bascode" localize="false">Function Round(</paragraph>
<paragraph id="par_id061420180708348729" role="bascode" localize="false">BaseValue as Double, </paragraph>
<paragraph id="par_id061420180708341926" role="bascode" localize="false">Decimals as Integer) as Double</paragraph>
</bascode>
<h3 id="hd_id061420180708344826" localize="false">FileNameoutofPath</h3>
<paragraph id="par_id061420180708348505" role="paragraph" localize="false">'Retrieves the mere filename out of a whole path</paragraph>
<bascode>
<paragraph id="par_id061420180708348090" role="bascode" localize="false">Function FileNameoutofPath(</paragraph>
<paragraph id="par_id06142018070834403" role="bascode" localize="false">ByVal Path as String, </paragraph>
<paragraph id="par_id061420180708347244" role="bascode" localize="false">Optional Separator as String) as String</paragraph>
</bascode>
<h3 id="hd_id06142018070834616" localize="false">GetFileNameExtension</h3>
<bascode>
<paragraph id="par_id061420180708342063" role="bascode" localize="false">Function GetFileNameExtension(</paragraph>
<paragraph id="par_id06142018070834483" role="bascode" localize="false">ByVal FileName as String)</paragraph>
</bascode>
<h3 id="hd_id061420180708342472" localize="false">GetFileNameWithoutExtension</h3>
<bascode>
<paragraph id="par_id061420180708347863" role="bascode" localize="false">Function GetFileNameWithoutExtension(</paragraph>
<paragraph id="par_id061420180708347793" role="bascode" localize="false">ByVal FileName as String, </paragraph>
<paragraph id="par_id061420180708341627" role="bascode" localize="false">Optional Separator as String)</paragraph>
</bascode>
<h3 id="hd_id061420180708347642" localize="false">DirectoryNameoutofPath</h3>
<bascode>
<paragraph id="par_id061420180708343404" role="bascode" localize="false">Function DirectoryNameoutofPath(</paragraph>
<paragraph id="par_id061420180708348454" role="bascode" localize="false">sPath as String, </paragraph>
<paragraph id="par_id061420180708344267" role="bascode" localize="false">Separator as String) as String</paragraph>
</bascode>
<h3 id="hd_id061420180708348485" localize="false">CountCharsinString</h3>
<bascode>
<paragraph id="par_id061420180708348315" role="bascode" localize="false">Function CountCharsinString(</paragraph>
<paragraph id="par_id061420180708343699" role="bascode" localize="false">BigString, </paragraph>
<paragraph id="par_id061420180708348022" role="bascode" localize="false">LocChar as String, </paragraph>
<paragraph id="par_id061420180708344991" role="bascode" localize="false">ByVal StartPos as Integer) as Integer</paragraph>
</bascode>
<h3 id="hd_id061420180708344129" localize="false">BubbleSortList</h3>
<bascode>
<paragraph id="par_id061420180708343944" role="bascode" localize="false">Function BubbleSortList(</paragraph>
<paragraph id="par_id061420180708347334" role="bascode" localize="false">ByVal SortList(),</paragraph>
<paragraph id="par_id061420180708352791" role="bascode" localize="false">optional sort2ndValue as Boolean)</paragraph>
</bascode>
<paragraph id="par_id061420180708355329" role="paragraph" localize="false">'This function bubble sorts an array of maximum 2 dimensions.</paragraph>
<paragraph id="par_id061420180708351446" role="paragraph" localize="false">'The default sorting order is the first dimension</paragraph>
<paragraph id="par_id061420180708359513" role="paragraph" localize="false">'Only if sort2ndValue is True the second dimension is the relevant for the sorting order</paragraph>
<h3 id="hd_id061420180708356687" localize="false">GetValueoutofList</h3>
<bascode>
<paragraph id="par_id061420180708359326" role="bascode" localize="false">Function GetValueoutofList(</paragraph>
<paragraph id="par_id061420180708358651" role="bascode" localize="false">SearchValue, </paragraph>
<paragraph id="par_id061420180708355610" role="bascode" localize="false">BigList(), </paragraph>
<paragraph id="par_id061420180708357288" role="bascode" localize="false">iDim as Integer, </paragraph>
<paragraph id="par_id061420180708353372" role="bascode" localize="false">Optional ValueIndex)</paragraph>
</bascode>
<h3 id="hd_id06142018070835957" localize="false">AddListtoList</h3>
<bascode>
<paragraph id="par_id061420180708359239" role="bascode" localize="false">Function AddListtoList(</paragraph>
<paragraph id="par_id061420180708356836" role="bascode" localize="false">ByVal FirstArray(), </paragraph>
<paragraph id="par_id061420180708353284" role="bascode" localize="false">ByVal SecondArray(), </paragraph>
<paragraph id="par_id061420180708352829" role="bascode" localize="false">Optional StartIndex)</paragraph>
</bascode>
<h3 id="hd_id06142018070835769" localize="false">CheckDouble</h3>
<bascode>
<paragraph id="par_id061420180708359797" role="bascode" localize="false">Function CheckDouble(DoubleString as String)</paragraph>
</bascode>
</section>
<bookmark branch="index" id="bm_id731529062695476">
<bookmark_value>BASIC Tools library;UCB module</bookmark_value>
</bookmark>
<section id="ucb_module">
<h2 id="hd_id461529005780299"><item type="literal">UCB</item> Module</h2>
<paragraph role="paragraph" id="par_id131529064870824"><emph>Universal Content Broker</emph> functions and subroutines.</paragraph>
<h3 id="hd_id061420180727434845" localize="false">ReadDirectories</h3>
<bascode>
<paragraph id="par_id061420180727437288" role="bascode" localize="false">Function ReadDirectories(</paragraph>
<paragraph id="par_id061420180727433237" role="bascode" localize="false">ByVal AnchorDir As String, </paragraph>
<paragraph id="par_id061420180727439074" role="bascode" localize="false">bRecursive as Boolean, </paragraph>
<paragraph id="par_id061420180727435295" role="bascode" localize="false">bcheckFileType as Boolean, </paragraph>
<paragraph id="par_id061420180727438646" role="bascode" localize="false">bGetByTitle as Boolean, </paragraph>
<paragraph id="par_id061420180727432828" role="bascode" localize="false">Optional sFileContent(), </paragraph>
<paragraph role="bascode" id="par_id641529061341375" localize="false">Optional sExtension as String)</paragraph>
</bascode>
<h3 id="hd_id061420180727437838" localize="false">AddFoldertoList</h3>
<bascode>
<paragraph id="par_id061420180727438938" role="bascode" localize="false">Sub AddFoldertoList(</paragraph>
<paragraph id="par_id061420180727439505" role="bascode" localize="false">sDirURL as String, </paragraph>
<paragraph id="par_id061420180727431203" role="bascode" localize="false">iDirIndex)</paragraph>
</bascode>
<h3 id="hd_id061420180727432439" localize="false">AddFileNameToList</h3>
<bascode>
<paragraph id="par_id061420180727436964" role="bascode" localize="false">Sub AddFileNameToList(</paragraph>
<paragraph id="par_id06142018072743660" role="bascode" localize="false">sFileArray(), </paragraph>
<paragraph id="par_id061420180727437595" role="bascode" localize="false">FileName as String, </paragraph>
<paragraph id="par_id061420180727438361" role="bascode" localize="false">FileContent as String, </paragraph>
<paragraph id="par_id061420180727438606" role="bascode" localize="false">bGetByTitle as Boolean, </paragraph>
<paragraph id="par_id061420180727443630" role="bascode" localize="false">CurIndex)</paragraph>
</bascode>
<h3 id="hd_id061420180727448222" localize="false">RetrieveDocTitle</h3>
<bascode>
<paragraph id="par_id061420180727449206" role="bascode" localize="false">Function RetrieveDocTitle(</paragraph>
<paragraph id="par_id061420180727449481" role="bascode" localize="false">oDocProps as Object, </paragraph>
<paragraph id="par_id061420180727442037" role="bascode" localize="false">sFileName as String) As String</paragraph>
</bascode>
<h3 id="hd_id061420180727441588" localize="false">GetRealFileContent</h3>
<paragraph id="par_id061420180727444743" role="paragraph" localize="false">' Retrieves The Filecontent of a Document by extracting the content</paragraph>
<paragraph id="par_id061420180727441850" role="paragraph" localize="false">' from the Header of the document</paragraph>
<bascode>
<paragraph id="par_id061420180727442427" role="bascode" localize="false">Function GetRealFileContent(</paragraph>
<paragraph role="bascode" id="par_id31529061382662" localize="false">FileName as String) As String</paragraph>
</bascode>
<h3 id="hd_id061420180727441712" localize="false">CopyRecursively</h3>
<bascode>
<paragraph id="par_id061420180727442141" role="bascode" localize="false">Function CopyRecursively(</paragraph>
<paragraph id="par_id061420180727444075" role="bascode" localize="false">SourceFilePath as String, </paragraph>
<paragraph id="par_id061420180727447821" role="bascode" localize="false">SourceStemDir as String, </paragraph>
<paragraph id="par_id061420180727449128" role="bascode" localize="false">TargetStemDir as String)</paragraph>
</bascode>
<h3 id="hd_id061420180727445345" localize="false">ShowHelperDialog</h3>
<paragraph id="par_id061420180727445226" role="paragraph" localize="false">' Opens a help url referenced by a Help ID that is retrieved from the calling button tag</paragraph>
<bascode>
<paragraph id="par_id061420180727444009" role="bascode" localize="false">Sub ShowHelperDialog(aEvent)</paragraph>
</bascode>
<h3 id="hd_id061420180727442283" localize="false">SaveDataToFile</h3>
<bascode>
<paragraph id="par_id06142018072744822" role="bascode" localize="false">Sub SaveDataToFile(</paragraph>
<paragraph id="par_id061420180727446132" role="bascode" localize="false">FilePath as String, </paragraph>
<paragraph id="par_id0614201807274429" role="bascode" localize="false">DataList())</paragraph>
</bascode>
<h3 id="hd_id061420180727442501" localize="false">LoadDataFromFile</h3>
<bascode>
<paragraph id="par_id061420180727441903" role="bascode" localize="false">Function LoadDataFromFile(</paragraph>
<paragraph id="par_id061420180727448904" role="bascode" localize="false">FilePath as String, </paragraph>
<paragraph id="par_id061420180727448778" role="bascode" localize="false">DataList()) as Boolean</paragraph>
</bascode>
<h3 id="hd_id06142018072744521" localize="false">CreateFolder</h3>
<bascode>
<paragraph id="par_id061420180727443924" role="bascode" localize="false">Function CreateFolder(sNewFolder) as Boolean</paragraph>
</bascode>
</section>
<section id="relatedTopics">
<embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/>
</section>
</body>
</helpdocument>
|
