help3xsl/default.css | 6
help3xsl/online_transform.xsl | 2
help3xsl/prism.css | 2
help3xsl/prism.js | 201 ++
source/text/sbasic/shared/03/lib_tools.xhp | 2280 +++++++++--------------------
5 files changed, 969 insertions(+), 1522 deletions(-)
New commits:
commit 24828f91e22842cdaf64faf7d22a028541e5746c
Author: Ilmari Lauhakangas <ilmari.lauhakan...@libreoffice.org>
AuthorDate: Sat Apr 16 16:42:40 2022 +0300
Commit: Olivier Hallot <olivier.hal...@libreoffice.org>
CommitDate: Sun Apr 17 16:38:31 2022 +0200
tdf#148621 Improve Basic Help layout
- Get rid of tables
- Add normalize-whitespace Prism plugin to get rid of useless indents
- Fix code blocks poking through sticky header
- Add some word wrapping CSS to fix mobile-unfriendliness
Change-Id: I73fd1e0678624b0d4bd5561f50e80990db5567be
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/133096
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hal...@libreoffice.org>
diff --git a/help3xsl/default.css b/help3xsl/default.css
index 085d323a9..2c5e59ac0 100644
--- a/help3xsl/default.css
+++ b/help3xsl/default.css
@@ -121,6 +121,7 @@ pre,
display: inline;
padding: 1px 3px;
font-family: var(--font_mono);
+ word-wrap: anywhere;
}
.smathcode {
border-radius: 2px;
@@ -178,6 +179,10 @@ pre,
.noteicon, .notetext {
padding:0.3em;
}
+/* Override some Prism.js styles */
+code[class*="language-"], pre[class*="language-"] {
+ white-space: pre-wrap;
+}
/* Table related classes */
@@ -603,6 +608,7 @@ li.disabled a {
background: #18A303;
top: 0px;
position: sticky;
+ z-index: 100;
}
.xapian-omega-search {
margin: auto;
diff --git a/help3xsl/online_transform.xsl b/help3xsl/online_transform.xsl
index 0751d7a86..465415ea2 100644
--- a/help3xsl/online_transform.xsl
+++ b/help3xsl/online_transform.xsl
@@ -143,8 +143,8 @@
<title><xsl:value-of disable-output-escaping="yes"
select="$titleL10N"/></title>
<link rel="shortcut icon" href="media/navigation/favicon.ico"/>
<link type="text/css" href="normalize.css" rel="Stylesheet"/>
- <link type="text/css" href="default.css" rel="Stylesheet"/>
<link type="text/css" href="prism.css" rel="Stylesheet"/>
+ <link type="text/css" href="default.css" rel="Stylesheet"/>
<script type="text/javascript" src="polyfills.js"></script>
<script type="text/javascript" src="languages.js"></script>
<script type="text/javascript" src="{$lang}/langnames.js"></script>
diff --git a/help3xsl/prism.css b/help3xsl/prism.css
index f974d0c87..79d07d18a 100644
--- a/help3xsl/prism.css
+++ b/help3xsl/prism.css
@@ -1,5 +1,5 @@
/* PrismJS 1.27.0
-https://prismjs.com/download.html#themes=prism-coy&languages=markup+css+clike+javascript+python+visual-basic&plugins=line-numbers
*/
+https://prismjs.com/download.html#themes=prism-coy&languages=markup+css+clike+javascript+python+visual-basic&plugins=line-numbers+normalize-whitespace
*/
/**
* prism.js Coy theme for JavaScript, CoffeeScript, CSS and HTML
* Based on https://github.com/tshedor/workshop-wp-theme (Example:
http://workshop.kansan.com/category/sessions/basics or
http://workshop.timshedor.com/category/sessions/basics);
diff --git a/help3xsl/prism.js b/help3xsl/prism.js
index 546388f44..4e00aeb04 100644
--- a/help3xsl/prism.js
+++ b/help3xsl/prism.js
@@ -1,5 +1,5 @@
/* PrismJS 1.27.0
-https://prismjs.com/download.html#themes=prism-coy&languages=markup+css+clike+javascript+python+visual-basic&plugins=line-numbers
*/
+https://prismjs.com/download.html#themes=prism-coy&languages=markup+css+clike+javascript+python+visual-basic&plugins=line-numbers+normalize-whitespace
*/
/// <reference lib="WebWorker"/>
var _self = (typeof window !== 'undefined')
@@ -2067,3 +2067,202 @@ Prism.languages.vba = Prism.languages['visual-basic'];
}());
+(function () {
+
+ if (typeof Prism === 'undefined') {
+ return;
+ }
+
+ var assign = Object.assign || function (obj1, obj2) {
+ for (var name in obj2) {
+ if (obj2.hasOwnProperty(name)) {
+ obj1[name] = obj2[name];
+ }
+ }
+ return obj1;
+ };
+
+ function NormalizeWhitespace(defaults) {
+ this.defaults = assign({}, defaults);
+ }
+
+ function toCamelCase(value) {
+ return value.replace(/-(\w)/g, function (match, firstChar) {
+ return firstChar.toUpperCase();
+ });
+ }
+
+ function tabLen(str) {
+ var res = 0;
+ for (var i = 0; i < str.length; ++i) {
+ if (str.charCodeAt(i) == '\t'.charCodeAt(0)) {
+ res += 3;
+ }
+ }
+ return str.length + res;
+ }
+
+ NormalizeWhitespace.prototype = {
+ setDefaults: function (defaults) {
+ this.defaults = assign(this.defaults, defaults);
+ },
+ normalize: function (input, settings) {
+ settings = assign(this.defaults, settings);
+
+ for (var name in settings) {
+ var methodName = toCamelCase(name);
+ if (name !== 'normalize' && methodName !==
'setDefaults' &&
+ settings[name] && this[methodName]) {
+ input = this[methodName].call(this,
input, settings[name]);
+ }
+ }
+
+ return input;
+ },
+
+ /*
+ * Normalization methods
+ */
+ leftTrim: function (input) {
+ return input.replace(/^\s+/, '');
+ },
+ rightTrim: function (input) {
+ return input.replace(/\s+$/, '');
+ },
+ tabsToSpaces: function (input, spaces) {
+ spaces = spaces|0 || 4;
+ return input.replace(/\t/g, new Array(++spaces).join('
'));
+ },
+ spacesToTabs: function (input, spaces) {
+ spaces = spaces|0 || 4;
+ return input.replace(RegExp(' {' + spaces + '}', 'g'),
'\t');
+ },
+ removeTrailing: function (input) {
+ return input.replace(/\s*?$/gm, '');
+ },
+ // Support for deprecated plugin remove-initial-line-feed
+ removeInitialLineFeed: function (input) {
+ return input.replace(/^(?:\r?\n|\r)/, '');
+ },
+ removeIndent: function (input) {
+ var indents = input.match(/^[^\S\n\r]*(?=\S)/gm);
+
+ if (!indents || !indents[0].length) {
+ return input;
+ }
+
+ indents.sort(function (a, b) { return a.length -
b.length; });
+
+ if (!indents[0].length) {
+ return input;
+ }
+
+ return input.replace(RegExp('^' + indents[0], 'gm'),
'');
+ },
+ indent: function (input, tabs) {
+ return input.replace(/^[^\S\n\r]*(?=\S)/gm, new
Array(++tabs).join('\t') + '$&');
+ },
+ breakLines: function (input, characters) {
+ characters = (characters === true) ? 80 : characters|0
|| 80;
+
+ var lines = input.split('\n');
+ for (var i = 0; i < lines.length; ++i) {
+ if (tabLen(lines[i]) <= characters) {
+ continue;
+ }
+
+ var line = lines[i].split(/(\s+)/g);
+ var len = 0;
+
+ for (var j = 0; j < line.length; ++j) {
+ var tl = tabLen(line[j]);
+ len += tl;
+ if (len > characters) {
+ line[j] = '\n' + line[j];
+ len = tl;
+ }
+ }
+ lines[i] = line.join('');
+ }
+ return lines.join('\n');
+ }
+ };
+
+ // Support node modules
+ if (typeof module !== 'undefined' && module.exports) {
+ module.exports = NormalizeWhitespace;
+ }
+
+ Prism.plugins.NormalizeWhitespace = new NormalizeWhitespace({
+ 'remove-trailing': true,
+ 'remove-indent': true,
+ 'left-trim': true,
+ 'right-trim': true,
+ /*'break-lines': 80,
+ 'indent': 2,
+ 'remove-initial-line-feed': false,
+ 'tabs-to-spaces': 4,
+ 'spaces-to-tabs': 4*/
+ });
+
+ Prism.hooks.add('before-sanity-check', function (env) {
+ var Normalizer = Prism.plugins.NormalizeWhitespace;
+
+ // Check settings
+ if (env.settings && env.settings['whitespace-normalization']
=== false) {
+ return;
+ }
+
+ // Check classes
+ if (!Prism.util.isActive(env.element,
'whitespace-normalization', true)) {
+ return;
+ }
+
+ // Simple mode if there is no env.element
+ if ((!env.element || !env.element.parentNode) && env.code) {
+ env.code = Normalizer.normalize(env.code, env.settings);
+ return;
+ }
+
+ // Normal mode
+ var pre = env.element.parentNode;
+ if (!env.code || !pre || pre.nodeName.toLowerCase() !== 'pre') {
+ return;
+ }
+
+ var children = pre.childNodes;
+ var before = '';
+ var after = '';
+ var codeFound = false;
+
+ // Move surrounding whitespace from the <pre> tag into the
<code> tag
+ for (var i = 0; i < children.length; ++i) {
+ var node = children[i];
+
+ if (node == env.element) {
+ codeFound = true;
+ } else if (node.nodeName === '#text') {
+ if (codeFound) {
+ after += node.nodeValue;
+ } else {
+ before += node.nodeValue;
+ }
+
+ pre.removeChild(node);
+ --i;
+ }
+ }
+
+ if (!env.element.children.length || !Prism.plugins.KeepMarkup) {
+ env.code = before + env.code + after;
+ env.code = Normalizer.normalize(env.code, env.settings);
+ } else {
+ // Preserve markup for keep-markup plugin
+ var html = before + env.element.innerHTML + after;
+ env.element.innerHTML = Normalizer.normalize(html,
env.settings);
+ env.code = env.element.textContent;
+ }
+ });
+
+}());
+
diff --git a/source/text/sbasic/shared/03/lib_tools.xhp
b/source/text/sbasic/shared/03/lib_tools.xhp
index 97a6935ae..5c2c7512e 100644
--- a/source/text/sbasic/shared/03/lib_tools.xhp
+++ b/source/text/sbasic/shared/03/lib_tools.xhp
@@ -37,168 +37,74 @@
<section id="debug_module">
<paragraph role="heading" id="hd_id371529000826947" level="2"
xml-lang="en-US"><item type="literal">Debug</item> Module</paragraph>
<paragraph role="paragraph" id="par_id441529064369519"
xml-lang="en-US">Functions and subroutines for debugging Basic
macros.</paragraph>
- <table id="tab_id31529001004856">
- <tablerow>
- <tablecell>
- <paragraph id="par_id801529001004856" role="tablehead"
xml-lang="en-US"><variable id="macro_name">Macro</variable></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id41529001004856" role="tablehead"
xml-lang="en-US"><variable id="call_param">Calling parameters and
comments</variable></paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id711529001004857" role="bascode"
xml-lang="en-US" localize="false">ActivateReadOnlyFlag</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id251529001003857" role="bascode"
xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id71529001663903" role="bascode"
xml-lang="en-US" localize="false">DeactivateReadOnlyFlag</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id951529001706210" role="bascode"
xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag()</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id421529001727178" role="bascode"
xml-lang="en-US" localize="false">SetBasicReadOnlyFlag</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id771529001755355" role="bascode"
xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as
Boolean)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id651529001954868" role="bascode"
xml-lang="en-US" localize="false">WritedbgInfo</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id581529001865055" role="bascode"
xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as
Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id841529001994821" role="bascode"
xml-lang="en-US" localize="false">WriteDbgString</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id171529002013434" role="bascode"
xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id741529002099962" role="bascode"
xml-lang="en-US" localize="false">ShowArray</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id261529002118559" role="bascode"
xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id321529002327444" role="bascode"
xml-lang="en-US" localize="false">ShowPropertyValues</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id501529002327444" role="bascode"
xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as
Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id451529002368600" role="bascode"
xml-lang="en-US" localize="false">ShowNameValuePair</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id321529002368600" role="bascode"
xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id551529002415495" role="bascode"
xml-lang="en-US" localize="false">ShowElementNames</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id111529003255859"
xml-lang="en-US" localize="false">' Retrieves all the Elements of
aSequence of an object, with the</paragraph>
- <paragraph role="tablecontent" id="par_id41529003238747"
xml-lang="en-US" localize="false">' possibility to define a filter(sfilter
<> "")</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id41529003225918"
xml-lang="en-US" localize="false">Sub ShowElementNames(</paragraph>
- <paragraph role="bascode" id="par_id321529005373289"
xml-lang="en-US" localize="false">oLocElements() as Object,</paragraph>
- <paragraph role="bascode" id="par_id1001529005296415"
xml-lang="en-US" localize="false">Optional sFiltername as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id581529003295045" role="bascode"
xml-lang="en-US" localize="false">ShowSupportedServiceNames</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id851529003295045" role="tablecontent"
xml-lang="en-US" localize="false">' Retrieves all the supported
servicenames of an object, with the </paragraph>
- <paragraph role="tablecontent" id="par_id301529003401893"
xml-lang="en-US" localize="false">' possibility to define a filter(sfilter
<> "")</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id801529003393056"
xml-lang="en-US" localize="false">Sub ShowSupportedServiceNames(</paragraph>
- <paragraph role="bascode" id="par_id101529005392934"
xml-lang="en-US" localize="false">oLocObject as Object,</paragraph>
- <paragraph role="bascode" id="par_id661529005271095"
xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id831529003429502" role="bascode"
xml-lang="en-US" localize="false">ShowAvailableServiceNames</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id401529003494638"
xml-lang="en-US" localize="false">' Retrieves all the available
Servicenames of an object, with the</paragraph>
- <paragraph role="tablecontent" id="par_id801529003504707"
xml-lang="en-US" localize="false">' possibility to define a filter(sfilter
<> "")</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id981529005231465"
xml-lang="en-US" localize="false">Sub ShowAvailableServiceNames(</paragraph>
- <paragraph role="bascode" id="par_id251529005237648"
xml-lang="en-US" localize="false">oLocObject as Object, </paragraph>
- <paragraph role="bascode" id="par_id721529005247098"
xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id591529003562090" role="bascode"
xml-lang="en-US" localize="false">ShowCommands</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id791529003562091" role="bascode"
xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as
Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id881529003602892" role="bascode"
xml-lang="en-US" localize="false">ProtectCurrentSheets</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id531529003602892" role="bascode"
xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id691529003635074" role="bascode"
xml-lang="en-US" localize="false">FillDocument</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id371529003635074" role="bascode"
xml-lang="en-US" localize="false">Sub FillDocument()</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- </table>
+ <h3 id="hd_id711529001004857" xml-lang="en-US"
localize="false">ActivateReadOnlyFlag</h3>
+ <bascode>
+ <paragraph id="par_id251529001003857" role="bascode"
xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph>
+ </bascode>
+ <h3 id="hd_id71529001663903" xml-lang="en-US"
localize="false">DeactivateReadOnlyFlag</h3>
+ <bascode>
+ <paragraph id="par_id951529001706210" role="bascode"
xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag()</paragraph>
+ </bascode>
+ <h3 id="hd_id421529001727178" xml-lang="en-US"
localize="false">SetBasicReadOnlyFlag</h3>
+ <bascode>
+ <paragraph id="par_id771529001755355" role="bascode"
xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as
Boolean)</paragraph>
+ </bascode>
+ <h3 id="hd_id651529001954868" xml-lang="en-US"
localize="false">WritedbgInfo</h3>
+ <bascode>
+ <paragraph id="par_id581529001865055" role="bascode"
xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id841529001994821" xml-lang="en-US"
localize="false">WriteDbgString</h3>
+ <bascode>
+ <paragraph id="par_id171529002013434" role="bascode"
xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as
String)</paragraph>
+ </bascode>
+ <h3 id="hd_id741529002099962" xml-lang="en-US"
localize="false">ShowArray</h3>
+ <bascode>
+ <paragraph id="par_id261529002118559" role="bascode"
xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph>
+ </bascode>
+ <h3 id="hd_id321529002327444" xml-lang="en-US"
localize="false">ShowPropertyValues</h3>
+ <bascode>
+ <paragraph id="par_id501529002327444" role="bascode"
xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id451529002368600" xml-lang="en-US"
localize="false">ShowNameValuePair</h3>
+ <bascode>
+ <paragraph id="par_id321529002368600" role="bascode"
xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph>
+ </bascode>
+ <h3 id="hd_id551529002415495" xml-lang="en-US"
localize="false">ShowElementNames</h3>
+ <paragraph id="par_id111529003255859" role="paragraph"
xml-lang="en-US" localize="false">' Retrieves all the Elements of
aSequence of an object, with the</paragraph>
+ <paragraph id="par_id41529003238747" role="paragraph" xml-lang="en-US"
localize="false">' possibility to define a filter(sfilter <>
"")</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id41529003225918"
xml-lang="en-US" localize="false">Sub ShowElementNames(</paragraph>
+ <paragraph role="bascode" id="par_id321529005373289"
xml-lang="en-US" localize="false">oLocElements() as Object,</paragraph>
+ <paragraph role="bascode" id="par_id1001529005296415"
xml-lang="en-US" localize="false">Optional sFiltername as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id581529003295045" xml-lang="en-US"
localize="false">ShowSupportedServiceNames</h3>
+ <paragraph id="par_id851529003295045" role="paragraph"
xml-lang="en-US" localize="false">' Retrieves all the supported
servicenames of an object, with the </paragraph>
+ <paragraph id="par_id301529003401893" role="paragraph"
xml-lang="en-US" localize="false">' possibility to define a filter(sfilter
<> "")</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id801529003393056"
xml-lang="en-US" localize="false">Sub ShowSupportedServiceNames(</paragraph>
+ <paragraph role="bascode" id="par_id101529005392934"
xml-lang="en-US" localize="false">oLocObject as Object,</paragraph>
+ <paragraph role="bascode" id="par_id661529005271095"
xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id831529003429502" xml-lang="en-US"
localize="false">ShowAvailableServiceNames</h3>
+ <paragraph id="par_id401529003494638" role="paragraph"
xml-lang="en-US" localize="false">' Retrieves all the available
Servicenames of an object, with the</paragraph>
+ <paragraph id="par_id801529003504707" role="paragraph"
xml-lang="en-US" localize="false">' possibility to define a filter(sfilter
<> "")</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id981529005231465"
xml-lang="en-US" localize="false">Sub ShowAvailableServiceNames(</paragraph>
+ <paragraph role="bascode" id="par_id251529005237648"
xml-lang="en-US" localize="false">oLocObject as Object, </paragraph>
+ <paragraph role="bascode" id="par_id721529005247098"
xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id591529003562090" xml-lang="en-US"
localize="false">ShowCommands</h3>
+ <bascode>
+ <paragraph id="par_id791529003562091" role="bascode"
xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id881529003602892" xml-lang="en-US"
localize="false">ProtectCurrentSheets</h3>
+ <bascode>
+ <paragraph id="par_id531529003602892" role="bascode"
xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph>
+ </bascode>
+ <h3 id="hd_id691529003635074" xml-lang="en-US"
localize="false">FillDocument</h3>
+ <bascode>
+ <paragraph id="par_id371529003635074" role="bascode"
xml-lang="en-US" localize="false">Sub FillDocument()</paragraph>
+ </bascode>
</section>
<bookmark xml-lang="en-US" branch="index" id="bm_id131529062501888">
<bookmark_value>BASIC Tools library;ListBox module</bookmark_value>
@@ -214,566 +120,280 @@
<section id="misc_module">
<paragraph role="heading" id="hd_id341529005758494" level="2"
xml-lang="en-US"><item type="literal">Misc</item> Module</paragraph>
<paragraph role="paragraph" id="par_id681529064596175"
xml-lang="en-US">Miscellaneous functions and subroutines.</paragraph>
- <table id="tab_id981529006338185">
- <tablerow>
- <tablecell>
- <paragraph id="par_id261529006338185" role="tablehead"
xml-lang="en-US" localize="false"><embedvar
href="text/sbasic/shared/03/lib_tools.xhp#macro_name"
markup="ignore"/></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id581529006338185" role="tablehead"
xml-lang="en-US" localize="false"><embedvar
href="text/sbasic/shared/03/lib_tools.xhp#call_param"
markup="ignore"/></paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id801529006604779" role="bascode"
xml-lang="en-US" localize="false">RegisterNewDataSource</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph role="bascode" id="par_id851529006689297"
xml-lang="en-US" localize="false">Function RegisterNewDataSource(</paragraph>
- <paragraph role="bascode" id="par_id471529006695330"
xml-lang="en-US" localize="false">DSName as String, </paragraph>
- <paragraph role="bascode" id="par_id671529006700462"
xml-lang="en-US" localize="false">PropertyList(), </paragraph>
- <paragraph role="bascode" id="par_id821529006705849"
xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph>
- <paragraph role="bascode" id="par_id321529061768930"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id501529006725521" role="bascode"
xml-lang="en-US" localize="false">ConnecttoDatabase</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph role="bascode" id="par_id771529006782954"
xml-lang="en-US" localize="false">Function ConnecttoDatabase(</paragraph>
- <paragraph role="bascode" id="par_id31529006789644"
xml-lang="en-US" localize="false">DSName as String, </paragraph>
- <paragraph role="bascode" id="par_id421529006794640"
xml-lang="en-US" localize="false">UserID as String, </paragraph>
- <paragraph role="bascode" id="par_id381529006799623"
xml-lang="en-US" localize="false">Password as String, </paragraph>
- <paragraph role="bascode" id="par_id641529006805066"
xml-lang="en-US" localize="false">Optional Propertylist(), </paragraph>
- <paragraph role="bascode" id="par_id201529006810077"
xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph>
- <paragraph role="bascode" id="par_id11529061810188"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id411529006832985" role="bascode"
xml-lang="en-US" localize="false">GetStarOfficeLocale</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id451529006832985" role="bascode"
xml-lang="en-US" localize="false">Function GetStarOfficeLocale() </paragraph>
- <paragraph role="bascode" id="par_id761529061825013"
xml-lang="en-US" localize="false">as New com.sun.star.lang.Locale</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id361529006902547" role="bascode"
xml-lang="en-US" localize="false">GetRegistryKeyContent</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph role="bascode" id="par_id391529006938605"
xml-lang="en-US" localize="false">Function GetRegistryKeyContent(</paragraph>
- <paragraph role="bascode" id="par_id881529006944515"
xml-lang="en-US" localize="false">sKeyName as string, </paragraph>
- <paragraph role="bascode" id="par_id711529006950283"
xml-lang="en-US" localize="false">Optional bforUpdate as Boolean)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id851529006965105" role="bascode"
xml-lang="en-US" localize="false">GetProductname</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id451529006965105" role="bascode"
xml-lang="en-US" localize="false">Function GetProductname() as
String</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id771529007007439" role="bascode"
xml-lang="en-US" localize="false">OpenDocument</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id821529007072253"
localize="false" xml-lang="en-US">' Opens a Document, checks beforehand,
whether it has to be loaded or whether it is already on the desktop. If the
parameter bDisposable is set to False then the returned document should not be
disposed afterwards, because it is already opened.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id991529007104165"
xml-lang="en-US" localize="false">Function OpenDocument(</paragraph>
- <paragraph role="bascode" id="par_id191529007110562"
xml-lang="en-US" localize="false">DocPath as String, </paragraph>
- <paragraph role="bascode" id="par_id851529007118783"
xml-lang="en-US" localize="false">Args(), </paragraph>
- <paragraph role="bascode" id="par_id691529007123485"
xml-lang="en-US" localize="false">Optional bDisposable as Boolean)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id481529007130534" role="bascode"
xml-lang="en-US" localize="false">TaskonDesktop</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id911529007130534" role="bascode"
xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as
Boolean</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id201529007205755" role="bascode"
xml-lang="en-US" localize="false">RetrieveFileName</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id81529007245965"
localize="false" xml-lang="en-US">' Retrieves a FileName out of a
StarOffice-Document.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id881529007259806"
xml-lang="en-US" localize="false">Function RetrieveFileName(LocDoc as
Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id121529007269721" role="bascode"
xml-lang="en-US" localize="false">GetPathSettings</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" localize="false"
id="par_id801529007338550" xml-lang="en-US">' Gets a special configured
PathSetting.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id971529007353940"
xml-lang="en-US" localize="false">Function GetPathSettings(</paragraph>
- <paragraph role="bascode" id="par_id401529007360579"
xml-lang="en-US" localize="false">sPathType as String,</paragraph>
- <paragraph role="bascode" id="par_id741529007366892"
xml-lang="en-US" localize="false">Optional bshowall as Boolean, </paragraph>
- <paragraph role="bascode" id="par_id841529007371792"
xml-lang="en-US" localize="false">Optional ListIndex as integer) as
String</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id571529007381828" role="bascode"
xml-lang="en-US" localize="false">GetOfficeSubPath</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id761529007616982"
localize="false" xml-lang="en-US">' Gets the fully qualified path to a
subdirectory of the Template Directory, e. g. with the parameter
"wizard/bitmap". The parameter must be passed over in Url-scription. The
return-Value is in Urlscription.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id981529007639916"
xml-lang="en-US" localize="false">Function GetOfficeSubPath(</paragraph>
- <paragraph role="bascode" id="par_id21529007645780"
xml-lang="en-US" localize="false">sOfficePath as String, </paragraph>
- <paragraph role="bascode" id="par_id201529007651880"
xml-lang="en-US" localize="false">ByVal sSubDir as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id591529007658281" role="bascode"
xml-lang="en-US" localize="false">ShowNoOfficePathError</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id511529007658281" role="bascode"
xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id431529007692356" role="bascode"
xml-lang="en-US" localize="false">InitResources</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id991529007692356" role="bascode"
xml-lang="en-US" localize="false">Function InitResources(</paragraph>
- <paragraph role="bascode" id="par_id651529007767824"
xml-lang="en-US" localize="false">Description, </paragraph>
- <paragraph role="bascode" id="par_id401529007773380"
xml-lang="en-US" localize="false">ShortDescription as String) as
boolean</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id611529007790857" role="bascode"
xml-lang="en-US" localize="false">GetResText</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id331529007790857" role="bascode"
xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As
string</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id971529007839780" role="bascode"
xml-lang="en-US" localize="false">CutPathView</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph role="bascode" id="par_id91529007882196"
xml-lang="en-US" localize="false">Function CutPathView(</paragraph>
- <paragraph role="bascode" id="par_id211529007888525"
xml-lang="en-US" localize="false">sDocUrl as String, </paragraph>
- <paragraph role="bascode" id="par_id361529007894202"
xml-lang="en-US" localize="false">Optional PathLen as Integer)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id51529007902118" role="bascode"
xml-lang="en-US" localize="false">DeleteInputCells</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id311529007997114"
localize="false" xml-lang="en-US">' Deletes the content of all cells that
are softformatted according to the 'InputStyleName'.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id111529008013953"
xml-lang="en-US" localize="false">Sub DeleteInputCells(</paragraph>
- <paragraph role="bascode" id="par_id731529008019208"
xml-lang="en-US" localize="false">oSheet as Object, </paragraph>
- <paragraph role="bascode" id="par_id881529008025944"
xml-lang="en-US" localize="false">InputStyleName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id881529008035409" role="bascode"
xml-lang="en-US" localize="false">ChangeValueofRange</paragraph>
- </tablecell>
- <tablecell>
- <paragraph role="tablecontent" id="par_id261529008090521"
xml-lang="en-US" localize="false">' Inserts a certain String to all cells
of a Range that ist passed over either as an object or as the
RangeName.</paragraph>
- <bascode>
- <paragraph role="bascode" id="par_id231529008110214"
xml-lang="en-US" localize="false">Sub ChangeValueofRange(</paragraph>
- <paragraph role="bascode" id="par_id401529008116727"
xml-lang="en-US" localize="false">oSheet as Object, </paragraph>
- <paragraph role="bascode" id="par_id211529008122524"
xml-lang="en-US" localize="false">Range, </paragraph>
- <paragraph role="bascode" id="par_id91529008128202"
xml-lang="en-US" localize="false">ReplaceValue, </paragraph>
- <paragraph role="bascode" id="par_id671529008133554"
xml-lang="en-US" localize="false">Optional StyleName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547275154" role="bascode"
localize="false" xml-lang="en-US">ReplaceRangeValues</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547275639"
role="bascode" localize="false" xml-lang="en-US">Sub
ReplaceRangeValues(</paragraph>
- <paragraph id="par_id061420180547279527"
role="bascode" localize="false" xml-lang="en-US">oRange as Object, </paragraph>
- <paragraph id="par_id061420180547277" role="bascode"
localize="false" xml-lang="en-US">ReplaceValue)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id06142018054727953" role="bascode"
localize="false" xml-lang="en-US">GetValueofCellbyName</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547271480"
role="tablecontent" xml-lang="en-US" localize="false">' Returns the Value of
the first cell of a Range.</paragraph>
- <bascode>
- <paragraph id="par_id061420180547275293"
role="bascode" localize="false" xml-lang="en-US">Function
GetValueofCellbyName(</paragraph>
- <paragraph id="par_id061420180547274365"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547272143"
role="bascode" localize="false" xml-lang="en-US">sCellName as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547273177" role="bascode"
localize="false" xml-lang="en-US">DuplicateRow</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547278695"
role="bascode" localize="false" xml-lang="en-US">Function
DuplicateRow(</paragraph>
- <paragraph id="par_id061420180547271430"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547271882"
role="bascode" localize="false" xml-lang="en-US">RangeName as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547271951" role="bascode"
localize="false" xml-lang="en-US">GetStringofCellbyName</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547275159"
role="tablecontent" xml-lang="en-US" localize="false">' Returns the String of
the first cell of a Range.</paragraph>
- <bascode>
- <paragraph id="par_id061420180547277611"
role="bascode" localize="false" xml-lang="en-US">Function
GetStringofCellbyName(</paragraph>
- <paragraph id="par_id061420180547271853"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547277036"
role="bascode" localize="false" xml-lang="en-US">sCellName as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547271528" role="bascode"
localize="false" xml-lang="en-US">GetCellByName</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547271588"
role="tablecontent" xml-lang="en-US" localize="false">' Returns a named
Cell</paragraph>
- <bascode>
- <paragraph id="par_id061420180547278497"
role="bascode" localize="false" xml-lang="en-US">Function
GetCellByName(</paragraph>
- <paragraph id="par_id061420180547284593"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547285667"
role="bascode" localize="false" xml-lang="en-US">sCellName as String) as
Object</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547288062" role="bascode"
localize="false" xml-lang="en-US">ChangeCellValue</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547288384"
role="tablecontent" xml-lang="en-US" localize="false">' Changes the numeric
Value of a cell by transmitting the String of the numeric Value.</paragraph>
- <bascode>
- <paragraph id="par_id061420180547287291"
role="bascode" localize="false" xml-lang="en-US">Sub
ChangeCellValue(</paragraph>
- <paragraph id="par_id061420180547287421"
role="bascode" localize="false" xml-lang="en-US">oCell as Object, </paragraph>
- <paragraph id="par_id061420180547283866"
role="bascode" localize="false" xml-lang="en-US">ValueString as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547283259" role="bascode"
localize="false" xml-lang="en-US">GetDocumentType</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547286797"
role="bascode" localize="false" xml-lang="en-US">Function
GetDocumentType(oDocument)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547288146" role="bascode"
localize="false" xml-lang="en-US">GetNumberFormatType</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547285276"
role="bascode" localize="false" xml-lang="en-US">Function
GetNumberFormatType(</paragraph>
- <paragraph id="par_id061420180547282526"
role="bascode" localize="false" xml-lang="en-US">oDocFormats, </paragraph>
- <paragraph id="par_id061420180547285804"
role="bascode" localize="false" xml-lang="en-US">oFormatObject as Object) as
Integer</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547282335" role="bascode"
localize="false" xml-lang="en-US">ProtectSheets</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547283563"
role="bascode" localize="false" xml-lang="en-US">Sub ProtectSheets(Optional
oSheets as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547285130" role="bascode"
localize="false" xml-lang="en-US">UnprotectSheets</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547289761"
role="bascode" localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional
oSheets as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547284142" role="bascode"
localize="false" xml-lang="en-US">GetRowIndex</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547284432"
role="bascode" localize="false" xml-lang="en-US">Function
GetRowIndex(</paragraph>
- <paragraph id="par_id061420180547284492"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547288316"
role="bascode" localize="false" xml-lang="en-US">RowName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547284556" role="bascode"
localize="false" xml-lang="en-US">GetColumnIndex</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547285812"
role="bascode" localize="false" xml-lang="en-US">Function
GetColumnIndex(</paragraph>
- <paragraph id="par_id061420180547287653"
role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
- <paragraph id="par_id061420180547285010"
role="bascode" localize="false" xml-lang="en-US">ColName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547285141" role="bascode"
localize="false" xml-lang="en-US">CopySheetbyName</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547284524"
role="bascode" localize="false" xml-lang="en-US">Function
CopySheetbyName(</paragraph>
- <paragraph id="par_id061420180547286144"
role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
- <paragraph id="par_id061420180547289148"
role="bascode" localize="false" xml-lang="en-US">OldName as String, </paragraph>
- <paragraph id="par_id061420180547287225"
role="bascode" localize="false" xml-lang="en-US">NewName as String, </paragraph>
- <paragraph id="par_id061420180547299943"
role="bascode" localize="false" xml-lang="en-US">DestPos as Integer) as
Object</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id0614201805472944" role="bascode"
localize="false" xml-lang="en-US">ToggleWindow</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547292068"
role="tablecontent" xml-lang="en-US" localize="false">' Dis-or enables a Window
and adjusts the mousepointer accordingly</paragraph>
- <bascode>
- <paragraph id="par_id061420180547296555"
role="bascode" localize="false" xml-lang="en-US">Sub ToggleWindow(bDoEnable as
Boolean)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547294361" role="bascode"
localize="false" xml-lang="en-US">CheckNewSheetname</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547292565"
role="bascode" localize="false" xml-lang="en-US">Function
CheckNewSheetname(</paragraph>
- <paragraph id="par_id061420180547293242"
role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
- <paragraph id="par_id061420180547297240"
role="bascode" localize="false" xml-lang="en-US">Sheetname as String,
</paragraph>
- <paragraph id="par_id061420180547294328"
role="bascode" localize="false" xml-lang="en-US">Optional oLocale) as
String</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547298278" role="bascode"
localize="false" xml-lang="en-US">AddNewSheetName</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547299974"
role="bascode" localize="false" xml-lang="en-US">Sub
AddNewSheetName(</paragraph>
- <paragraph id="par_id061420180547292009"
role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
- <paragraph id="par_id061420180547293223"
role="bascode" localize="false" xml-lang="en-US">ByVal SheetName as
String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547293964" role="bascode"
localize="false" xml-lang="en-US">GetSheetIndex</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id06142018054729713" role="bascode"
localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as
Integer</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547298034" role="bascode"
localize="false" xml-lang="en-US">GetLastUsedRow</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547299520"
role="bascode" localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet
as Object) as Integer</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547294665" role="bascode"
localize="false" xml-lang="en-US">ModifyBorderLineWidth</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547295117"
role="tablecontent" xml-lang="en-US" localize="false">' Note To set a one lined
frame you have to set the inner width to 0 In the API all Units that refer to
pt-Heights are "1/100mm" The convert factor from 1pt to 1/100 mm is
approximately 35 </paragraph>
- <bascode>
- <paragraph id="par_id061420180547295225"
role="bascode" localize="false" xml-lang="en-US">Function
ModifyBorderLineWidth(</paragraph>
- <paragraph id="par_id061420180547292084"
role="bascode" localize="false" xml-lang="en-US">ByVal oStyleBorder,
</paragraph>
- <paragraph id="par_id061420180547292560"
role="bascode" localize="false" xml-lang="en-US">iInnerLineWidth as Integer,
</paragraph>
- <paragraph id="par_id061420180547295476"
role="bascode" localize="false" xml-lang="en-US">iOuterLineWidth as
Integer)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id06142018054729303" role="bascode"
localize="false" xml-lang="en-US">AttachBasicMacroToEvent</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547296417"
role="bascode" localize="false" xml-lang="en-US">Sub
AttachBasicMacroToEvent(</paragraph>
- <paragraph id="par_id061420180547292774"
role="bascode" localize="false" xml-lang="en-US">oDocument as Object,
</paragraph>
- <paragraph id="par_id061420180547291074"
role="bascode" localize="false" xml-lang="en-US">EventName as String,
</paragraph>
- <paragraph id="par_id061420180547293426"
role="bascode" localize="false" xml-lang="en-US">SubPath as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547308735" role="bascode"
localize="false" xml-lang="en-US">ModifyPropertyValue</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547306755"
role="bascode" localize="false" xml-lang="en-US">Function
ModifyPropertyValue(</paragraph>
- <paragraph id="par_id061420180547304617"
role="bascode" localize="false" xml-lang="en-US">oContent() as New
com.sun.star.beans.PropertyValue, </paragraph>
- <paragraph id="par_id061420180547301558"
role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph>
- <paragraph role="bascode" id="par_id941529062083471"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id06142018054730528" role="bascode"
localize="false" xml-lang="en-US">GetPropertyValueIndex</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547304668"
role="bascode" localize="false" xml-lang="en-US">Function
GetPropertyValueIndex(</paragraph>
- <paragraph id="par_id061420180547302428"
role="bascode" localize="false" xml-lang="en-US">SearchName as String,
</paragraph>
- <paragraph id="par_id061420180547306561"
role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph>
- <paragraph role="bascode" id="par_id971529062111510"
xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue ) as
Integer</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547305379" role="bascode"
localize="false" xml-lang="en-US">DispatchSlot</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547302087"
role="bascode" localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as
Integer)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547308065" role="bascode"
localize="false" xml-lang="en-US">IsFatOffice</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547306757"
role="tablecontent" xml-lang="en-US" localize="false">'returns the type of the
office application FatOffice = 0, WebTop = 1 This routine has to be changed if
the Product Name is being changed! </paragraph>
- <bascode>
- <paragraph id="par_id061420180547302561"
role="bascode" localize="false" xml-lang="en-US">Function IsFatOffice() As
Boolean</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id06142018054730408" role="bascode"
localize="false" xml-lang="en-US">GetLocale</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547306751"
role="bascode" localize="false" xml-lang="en-US">Function GetLocale(</paragraph>
- <paragraph id="par_id061420180547302792"
role="bascode" localize="false" xml-lang="en-US">sLanguage as String,
</paragraph>
- <paragraph id="par_id061420180547307976"
role="bascode" localize="false" xml-lang="en-US">sCountry as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547305357" role="bascode"
localize="false" xml-lang="en-US">ToggleDesignMode</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547301559"
role="bascode" localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument
as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547301521" role="bascode"
localize="false" xml-lang="en-US">isHighContrast</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547302307"
role="bascode" localize="false" xml-lang="en-US">Function isHighContrast(oPeer
as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547302524" role="bascode"
localize="false" xml-lang="en-US">CreateNewDocument</paragraph>
- </tablecell>
- <tablecell>
- <bascode>
- <paragraph id="par_id061420180547302408"
role="bascode" localize="false" xml-lang="en-US">Function
CreateNewDocument(</paragraph>
- <paragraph id="par_id061420180547306406"
role="bascode" localize="false" xml-lang="en-US">sType as String, </paragraph>
- <paragraph id="par_id061420180547302638"
role="bascode" localize="false" xml-lang="en-US">Optional sAddMsg as String) as
Object</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547306821" role="bascode"
localize="false" xml-lang="en-US">DisposeDocument</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547308844"
role="tablecontent" localize="false" xml-lang="en-US">' This Sub has been used
in order to ensure that after disposing a document from the backing window it
is returned to the backing window, so the office won't be closed</paragraph>
- <bascode>
- <paragraph id="par_id061420180547301077"
role="bascode" localize="false" xml-lang="en-US">Sub DisposeDocument(oDocument
as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061420180547316190" role="bascode"
localize="false" xml-lang="en-US">CalIsLeapYear</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061420180547311590"
role="tablecontent" xml-lang="en-US" localize="false">'Function to calculate if
the year is a leap year</paragraph>
- <bascode>
- <paragraph id="par_id061420180547311314"
role="bascode" localize="false" xml-lang="en-US">Function
CalIsLeapYear(</paragraph>
- <paragraph role="bascode" id="par_id401529062200648"
xml-lang="en-US" localize="false">ByVal iYear as Integer) as Boolean</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- </table>
+ <h3 id="hd_id801529006604779" xml-lang="en-US"
localize="false">RegisterNewDataSource</h3>
+ <bascode>
+ <paragraph role="bascode" id="par_id851529006689297"
xml-lang="en-US" localize="false">Function RegisterNewDataSource(</paragraph>
+ <paragraph role="bascode" id="par_id471529006695330"
xml-lang="en-US" localize="false">DSName as String, </paragraph>
+ <paragraph role="bascode" id="par_id671529006700462"
xml-lang="en-US" localize="false">PropertyList(), </paragraph>
+ <paragraph role="bascode" id="par_id821529006705849"
xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph>
+ <paragraph role="bascode" id="par_id321529061768930"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
+ </bascode>
+ <h3 id="hd_id501529006725521" xml-lang="en-US"
localize="false">ConnecttoDatabase</h3>
+ <bascode>
+ <paragraph role="bascode" id="par_id771529006782954"
xml-lang="en-US" localize="false">Function ConnecttoDatabase(</paragraph>
+ <paragraph role="bascode" id="par_id31529006789644"
xml-lang="en-US" localize="false">DSName as String, </paragraph>
+ <paragraph role="bascode" id="par_id421529006794640"
xml-lang="en-US" localize="false">UserID as String, </paragraph>
+ <paragraph role="bascode" id="par_id381529006799623"
xml-lang="en-US" localize="false">Password as String, </paragraph>
+ <paragraph role="bascode" id="par_id641529006805066"
xml-lang="en-US" localize="false">Optional Propertylist(), </paragraph>
+ <paragraph role="bascode" id="par_id201529006810077"
xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph>
+ <paragraph role="bascode" id="par_id11529061810188"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
+ </bascode>
+ <h3 id="hd_id411529006832985" xml-lang="en-US"
localize="false">GetStarOfficeLocale</h3>
+ <bascode>
+ <paragraph id="par_id451529006832985" role="bascode"
xml-lang="en-US" localize="false">Function GetStarOfficeLocale() </paragraph>
+ <paragraph role="bascode" id="par_id761529061825013"
xml-lang="en-US" localize="false">as New com.sun.star.lang.Locale</paragraph>
+ </bascode>
+ <h3 id="hd_id361529006902547" xml-lang="en-US"
localize="false">GetRegistryKeyContent</h3>
+ <bascode>
+ <paragraph role="bascode" id="par_id391529006938605"
xml-lang="en-US" localize="false">Function GetRegistryKeyContent(</paragraph>
+ <paragraph role="bascode" id="par_id881529006944515"
xml-lang="en-US" localize="false">sKeyName as string, </paragraph>
+ <paragraph role="bascode" id="par_id711529006950283"
xml-lang="en-US" localize="false">Optional bforUpdate as Boolean)</paragraph>
+ </bascode>
+ <h3 id="hd_id851529006965105" xml-lang="en-US"
localize="false">GetProductname</h3>
+ <bascode>
+ <paragraph id="par_id451529006965105" role="bascode"
xml-lang="en-US" localize="false">Function GetProductname() as
String</paragraph>
+ </bascode>
+ <h3 id="hd_id771529007007439" xml-lang="en-US"
localize="false">OpenDocument</h3>
+ <paragraph id="par_id821529007072253" role="paragraph"
localize="false" xml-lang="en-US">' Opens a Document, checks beforehand,
whether it has to be loaded or whether it is already on the desktop. If the
parameter bDisposable is set to False then the returned document should not be
disposed afterwards, because it is already opened.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id991529007104165"
xml-lang="en-US" localize="false">Function OpenDocument(</paragraph>
+ <paragraph role="bascode" id="par_id191529007110562"
xml-lang="en-US" localize="false">DocPath as String, </paragraph>
+ <paragraph role="bascode" id="par_id851529007118783"
xml-lang="en-US" localize="false">Args(), </paragraph>
+ <paragraph role="bascode" id="par_id691529007123485"
xml-lang="en-US" localize="false">Optional bDisposable as Boolean)</paragraph>
+ </bascode>
+ <h3 id="hd_id481529007130534" xml-lang="en-US"
localize="false">TaskonDesktop</h3>
+ <bascode>
+ <paragraph id="par_id911529007130534" role="bascode"
xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as
Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id201529007205755" xml-lang="en-US"
localize="false">RetrieveFileName</h3>
+ <paragraph id="par_id81529007245965" role="paragraph" localize="false"
xml-lang="en-US">' Retrieves a FileName out of a
StarOffice-Document.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id881529007259806"
xml-lang="en-US" localize="false">Function RetrieveFileName(LocDoc as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id121529007269721" xml-lang="en-US"
localize="false">GetPathSettings</h3>
+ <paragraph id="par_id801529007338550" role="paragraph"
localize="false" xml-lang="en-US">' Gets a special configured
PathSetting.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id971529007353940"
xml-lang="en-US" localize="false">Function GetPathSettings(</paragraph>
+ <paragraph role="bascode" id="par_id401529007360579"
xml-lang="en-US" localize="false">sPathType as String,</paragraph>
+ <paragraph role="bascode" id="par_id741529007366892"
xml-lang="en-US" localize="false">Optional bshowall as Boolean, </paragraph>
+ <paragraph role="bascode" id="par_id841529007371792"
xml-lang="en-US" localize="false">Optional ListIndex as integer) as
String</paragraph>
+ </bascode>
+ <h3 id="hd_id571529007381828" xml-lang="en-US"
localize="false">GetOfficeSubPath</h3>
+ <paragraph id="par_id761529007616982" role="paragraph"
localize="false" xml-lang="en-US">' Gets the fully qualified path to a
subdirectory of the Template Directory, e. g. with the parameter
"wizard/bitmap". The parameter must be passed over in Url-scription. The
return-Value is in Urlscription.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id981529007639916"
xml-lang="en-US" localize="false">Function GetOfficeSubPath(</paragraph>
+ <paragraph role="bascode" id="par_id21529007645780"
xml-lang="en-US" localize="false">sOfficePath as String, </paragraph>
+ <paragraph role="bascode" id="par_id201529007651880"
xml-lang="en-US" localize="false">ByVal sSubDir as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id591529007658281" xml-lang="en-US"
localize="false">ShowNoOfficePathError</h3>
+ <bascode>
+ <paragraph id="par_id511529007658281" role="bascode"
xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph>
+ </bascode>
+ <h3 id="hd_id431529007692356" xml-lang="en-US"
localize="false">InitResources</h3>
+ <bascode>
+ <paragraph id="par_id991529007692356" role="bascode"
xml-lang="en-US" localize="false">Function InitResources(</paragraph>
+ <paragraph role="bascode" id="par_id651529007767824"
xml-lang="en-US" localize="false">Description, </paragraph>
+ <paragraph role="bascode" id="par_id401529007773380"
xml-lang="en-US" localize="false">ShortDescription as String) as
boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id611529007790857" xml-lang="en-US"
localize="false">GetResText</h3>
+ <bascode>
+ <paragraph id="par_id331529007790857" role="bascode"
xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As
string</paragraph>
+ </bascode>
+ <h3 id="hd_id971529007839780" xml-lang="en-US"
localize="false">CutPathView</h3>
+ <bascode>
+ <paragraph role="bascode" id="par_id91529007882196"
xml-lang="en-US" localize="false">Function CutPathView(</paragraph>
+ <paragraph role="bascode" id="par_id211529007888525"
xml-lang="en-US" localize="false">sDocUrl as String, </paragraph>
+ <paragraph role="bascode" id="par_id361529007894202"
xml-lang="en-US" localize="false">Optional PathLen as Integer)</paragraph>
+ </bascode>
+ <h3 id="hd_id51529007902118" xml-lang="en-US"
localize="false">DeleteInputCells</h3>
+ <paragraph id="par_id311529007997114" role="paragraph"
localize="false" xml-lang="en-US">' Deletes the content of all cells that
are softformatted according to the 'InputStyleName'.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id111529008013953"
xml-lang="en-US" localize="false">Sub DeleteInputCells(</paragraph>
+ <paragraph role="bascode" id="par_id731529008019208"
xml-lang="en-US" localize="false">oSheet as Object, </paragraph>
+ <paragraph role="bascode" id="par_id881529008025944"
xml-lang="en-US" localize="false">InputStyleName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id881529008035409" xml-lang="en-US"
localize="false">ChangeValueofRange</h3>
+ <paragraph id="par_id261529008090521" role="paragraph"
xml-lang="en-US" localize="false">' Inserts a certain String to all cells
of a Range that ist passed over either as an object or as the
RangeName.</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="par_id231529008110214"
xml-lang="en-US" localize="false">Sub ChangeValueofRange(</paragraph>
+ <paragraph role="bascode" id="par_id401529008116727"
xml-lang="en-US" localize="false">oSheet as Object, </paragraph>
+ <paragraph role="bascode" id="par_id211529008122524"
xml-lang="en-US" localize="false">Range, </paragraph>
+ <paragraph role="bascode" id="par_id91529008128202"
xml-lang="en-US" localize="false">ReplaceValue, </paragraph>
+ <paragraph role="bascode" id="par_id671529008133554"
xml-lang="en-US" localize="false">Optional StyleName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547275154" xml-lang="en-US"
localize="false">ReplaceRangeValues</h3>
+ <bascode>
+ <paragraph id="par_id061420180547275639" role="bascode"
localize="false" xml-lang="en-US">Sub ReplaceRangeValues(</paragraph>
+ <paragraph id="par_id061420180547279527" role="bascode"
localize="false" xml-lang="en-US">oRange as Object, </paragraph>
+ <paragraph id="par_id061420180547277" role="bascode"
localize="false" xml-lang="en-US">ReplaceValue)</paragraph>
+ </bascode>
+ <h3 id="hd_id06142018054727953" xml-lang="en-US"
localize="false">GetValueofCellbyName</h3>
+ <paragraph id="par_id061420180547271480" role="paragraph"
xml-lang="en-US" localize="false">' Returns the Value of the first cell of a
Range.</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547275293" role="bascode"
localize="false" xml-lang="en-US">Function GetValueofCellbyName(</paragraph>
+ <paragraph id="par_id061420180547274365" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547272143" role="bascode"
localize="false" xml-lang="en-US">sCellName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547273177" xml-lang="en-US"
localize="false">DuplicateRow</h3>
+ <bascode>
+ <paragraph id="par_id061420180547278695" role="bascode"
localize="false" xml-lang="en-US">Function DuplicateRow(</paragraph>
+ <paragraph id="par_id061420180547271430" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547271882" role="bascode"
localize="false" xml-lang="en-US">RangeName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547271951" xml-lang="en-US"
localize="false">GetStringofCellbyName</h3>
+ <paragraph id="par_id061420180547275159" role="paragraph"
xml-lang="en-US" localize="false">' Returns the String of the first cell of a
Range.</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547277611" role="bascode"
localize="false" xml-lang="en-US">Function GetStringofCellbyName(</paragraph>
+ <paragraph id="par_id061420180547271853" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547277036" role="bascode"
localize="false" xml-lang="en-US">sCellName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547271528" xml-lang="en-US"
localize="false">GetCellByName</h3>
+ <paragraph id="par_id061420180547271588" role="paragraph"
xml-lang="en-US" localize="false">' Returns a named Cell</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547278497" role="bascode"
localize="false" xml-lang="en-US">Function GetCellByName(</paragraph>
+ <paragraph id="par_id061420180547284593" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547285667" role="bascode"
localize="false" xml-lang="en-US">sCellName as String) as Object</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547288062" xml-lang="en-US"
localize="false">ChangeCellValue</h3>
+ <paragraph id="par_id061420180547288384" role="paragraph"
xml-lang="en-US" localize="false">' Changes the numeric Value of a cell by
transmitting the String of the numeric Value.</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547287291" role="bascode"
localize="false" xml-lang="en-US">Sub ChangeCellValue(</paragraph>
+ <paragraph id="par_id061420180547287421" role="bascode"
localize="false" xml-lang="en-US">oCell as Object, </paragraph>
+ <paragraph id="par_id061420180547283866" role="bascode"
localize="false" xml-lang="en-US">ValueString as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547283259" xml-lang="en-US"
localize="false">GetDocumentType</h3>
+ <bascode>
+ <paragraph id="par_id061420180547286797" role="bascode"
localize="false" xml-lang="en-US">Function
GetDocumentType(oDocument)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547288146" xml-lang="en-US"
localize="false">GetNumberFormatType</h3>
+ <bascode>
+ <paragraph id="par_id061420180547285276" role="bascode"
localize="false" xml-lang="en-US">Function GetNumberFormatType(</paragraph>
+ <paragraph id="par_id061420180547282526" role="bascode"
localize="false" xml-lang="en-US">oDocFormats, </paragraph>
+ <paragraph id="par_id061420180547285804" role="bascode"
localize="false" xml-lang="en-US">oFormatObject as Object) as
Integer</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547282335" xml-lang="en-US"
localize="false">ProtectSheets</h3>
+ <bascode>
+ <paragraph id="par_id061420180547283563" role="bascode"
localize="false" xml-lang="en-US">Sub ProtectSheets(Optional oSheets as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547285130" xml-lang="en-US"
localize="false">UnprotectSheets</h3>
+ <bascode>
+ <paragraph id="par_id061420180547289761" role="bascode"
localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional oSheets as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547284142" xml-lang="en-US"
localize="false">GetRowIndex</h3>
+ <bascode>
+ <paragraph id="par_id061420180547284432" role="bascode"
localize="false" xml-lang="en-US">Function GetRowIndex(</paragraph>
+ <paragraph id="par_id061420180547284492" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547288316" role="bascode"
localize="false" xml-lang="en-US">RowName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547284556" xml-lang="en-US"
localize="false">GetColumnIndex</h3>
+ <bascode>
+ <paragraph id="par_id061420180547285812" role="bascode"
localize="false" xml-lang="en-US">Function GetColumnIndex(</paragraph>
+ <paragraph id="par_id061420180547287653" role="bascode"
localize="false" xml-lang="en-US">oSheet as Object, </paragraph>
+ <paragraph id="par_id061420180547285010" role="bascode"
localize="false" xml-lang="en-US">ColName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547285141" xml-lang="en-US"
localize="false">CopySheetbyName</h3>
+ <bascode>
+ <paragraph id="par_id061420180547284524" role="bascode"
localize="false" xml-lang="en-US">Function CopySheetbyName(</paragraph>
+ <paragraph id="par_id061420180547286144" role="bascode"
localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
+ <paragraph id="par_id061420180547289148" role="bascode"
localize="false" xml-lang="en-US">OldName as String, </paragraph>
+ <paragraph id="par_id061420180547287225" role="bascode"
localize="false" xml-lang="en-US">NewName as String, </paragraph>
+ <paragraph id="par_id061420180547299943" role="bascode"
localize="false" xml-lang="en-US">DestPos as Integer) as Object</paragraph>
+ </bascode>
+ <h3 id="hd_id0614201805472944" xml-lang="en-US"
localize="false">ToggleWindow</h3>
+ <paragraph id="par_id061420180547292068" role="paragraph"
xml-lang="en-US" localize="false">' Dis-or enables a Window and adjusts the
mousepointer accordingly</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547296555" role="bascode"
localize="false" xml-lang="en-US">Sub ToggleWindow(bDoEnable as
Boolean)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547294361" xml-lang="en-US"
localize="false">CheckNewSheetname</h3>
+ <bascode>
+ <paragraph id="par_id061420180547292565" role="bascode"
localize="false" xml-lang="en-US">Function CheckNewSheetname(</paragraph>
+ <paragraph id="par_id061420180547293242" role="bascode"
localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
+ <paragraph id="par_id061420180547297240" role="bascode"
localize="false" xml-lang="en-US">Sheetname as String, </paragraph>
+ <paragraph id="par_id061420180547294328" role="bascode"
localize="false" xml-lang="en-US">Optional oLocale) as String</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547298278" xml-lang="en-US"
localize="false">AddNewSheetName</h3>
+ <bascode>
+ <paragraph id="par_id061420180547299974" role="bascode"
localize="false" xml-lang="en-US">Sub AddNewSheetName(</paragraph>
+ <paragraph id="par_id061420180547292009" role="bascode"
localize="false" xml-lang="en-US">oSheets as Object, </paragraph>
+ <paragraph id="par_id061420180547293223" role="bascode"
localize="false" xml-lang="en-US">ByVal SheetName as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547293964" xml-lang="en-US"
localize="false">GetSheetIndex</h3>
+ <bascode>
+ <paragraph id="par_id06142018054729713" role="bascode"
localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as
Integer</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547298034" xml-lang="en-US"
localize="false">GetLastUsedRow</h3>
+ <bascode>
+ <paragraph id="par_id061420180547299520" role="bascode"
localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet as Object) as
Integer</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547294665" xml-lang="en-US"
localize="false">ModifyBorderLineWidth</h3>
+ <paragraph id="par_id061420180547295117" role="paragraph"
xml-lang="en-US" localize="false">' Note To set a one lined frame you have to
set the inner width to 0 In the API all Units that refer to pt-Heights are
"1/100mm" The convert factor from 1pt to 1/100 mm is approximately 35
</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547295225" role="bascode"
localize="false" xml-lang="en-US">Function ModifyBorderLineWidth(</paragraph>
+ <paragraph id="par_id061420180547292084" role="bascode"
localize="false" xml-lang="en-US">ByVal oStyleBorder, </paragraph>
+ <paragraph id="par_id061420180547292560" role="bascode"
localize="false" xml-lang="en-US">iInnerLineWidth as Integer, </paragraph>
+ <paragraph id="par_id061420180547295476" role="bascode"
localize="false" xml-lang="en-US">iOuterLineWidth as Integer)</paragraph>
+ </bascode>
+ <h3 id="hd_id06142018054729303" xml-lang="en-US"
localize="false">AttachBasicMacroToEvent</h3>
+ <bascode>
+ <paragraph id="par_id061420180547296417" role="bascode"
localize="false" xml-lang="en-US">Sub AttachBasicMacroToEvent(</paragraph>
+ <paragraph id="par_id061420180547292774" role="bascode"
localize="false" xml-lang="en-US">oDocument as Object, </paragraph>
+ <paragraph id="par_id061420180547291074" role="bascode"
localize="false" xml-lang="en-US">EventName as String, </paragraph>
+ <paragraph id="par_id061420180547293426" role="bascode"
localize="false" xml-lang="en-US">SubPath as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547308735" xml-lang="en-US"
localize="false">ModifyPropertyValue</h3>
+ <bascode>
+ <paragraph id="par_id061420180547306755" role="bascode"
localize="false" xml-lang="en-US">Function ModifyPropertyValue(</paragraph>
+ <paragraph id="par_id061420180547304617" role="bascode"
localize="false" xml-lang="en-US">oContent() as New
com.sun.star.beans.PropertyValue, </paragraph>
+ <paragraph id="par_id061420180547301558" role="bascode"
localize="false" xml-lang="en-US">TargetProperties() </paragraph>
+ <paragraph role="bascode" id="par_id941529062083471"
xml-lang="en-US" localize="false">as New
com.sun.star.beans.PropertyValue)</paragraph>
+ </bascode>
+ <h3 id="hd_id06142018054730528" xml-lang="en-US"
localize="false">GetPropertyValueIndex</h3>
+ <bascode>
+ <paragraph id="par_id061420180547304668" role="bascode"
localize="false" xml-lang="en-US">Function GetPropertyValueIndex(</paragraph>
+ <paragraph id="par_id061420180547302428" role="bascode"
localize="false" xml-lang="en-US">SearchName as String, </paragraph>
+ <paragraph id="par_id061420180547306561" role="bascode"
localize="false" xml-lang="en-US">TargetProperties() </paragraph>
+ <paragraph role="bascode" id="par_id971529062111510"
xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue ) as
Integer</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547305379" xml-lang="en-US"
localize="false">DispatchSlot</h3>
+ <bascode>
+ <paragraph id="par_id061420180547302087" role="bascode"
localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as
Integer)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547308065" xml-lang="en-US"
localize="false">IsFatOffice</h3>
+ <paragraph id="par_id061420180547306757" role="paragraph"
xml-lang="en-US" localize="false">'returns the type of the office application
FatOffice = 0, WebTop = 1 This routine has to be changed if the Product Name is
being changed! </paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547302561" role="bascode"
localize="false" xml-lang="en-US">Function IsFatOffice() As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id06142018054730408" xml-lang="en-US"
localize="false">GetLocale</h3>
+ <bascode>
+ <paragraph id="par_id061420180547306751" role="bascode"
localize="false" xml-lang="en-US">Function GetLocale(</paragraph>
+ <paragraph id="par_id061420180547302792" role="bascode"
localize="false" xml-lang="en-US">sLanguage as String, </paragraph>
+ <paragraph id="par_id061420180547307976" role="bascode"
localize="false" xml-lang="en-US">sCountry as String)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547305357" xml-lang="en-US"
localize="false">ToggleDesignMode</h3>
+ <bascode>
+ <paragraph id="par_id061420180547301559" role="bascode"
localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547301521" xml-lang="en-US"
localize="false">isHighContrast</h3>
+ <bascode>
+ <paragraph id="par_id061420180547302307" role="bascode"
localize="false" xml-lang="en-US">Function isHighContrast(oPeer as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547302524" xml-lang="en-US"
localize="false">CreateNewDocument</h3>
+ <bascode>
+ <paragraph id="par_id061420180547302408" role="bascode"
localize="false" xml-lang="en-US">Function CreateNewDocument(</paragraph>
+ <paragraph id="par_id061420180547306406" role="bascode"
localize="false" xml-lang="en-US">sType as String, </paragraph>
+ <paragraph id="par_id061420180547302638" role="bascode"
localize="false" xml-lang="en-US">Optional sAddMsg as String) as
Object</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547306821" xml-lang="en-US"
localize="false">DisposeDocument</h3>
+ <paragraph id="par_id061420180547308844" role="paragraph"
localize="false" xml-lang="en-US">' This Sub has been used in order to ensure
that after disposing a document from the backing window it is returned to the
backing window, so the office won't be closed</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547301077" role="bascode"
localize="false" xml-lang="en-US">Sub DisposeDocument(oDocument as
Object)</paragraph>
+ </bascode>
+ <h3 id="hd_id061420180547316190" xml-lang="en-US"
localize="false">CalIsLeapYear</h3>
+ <paragraph id="par_id061420180547311590" role="paragraph"
xml-lang="en-US" localize="false">'Function to calculate if the year is a leap
year</paragraph>
+ <bascode>
+ <paragraph id="par_id061420180547311314" role="bascode"
localize="false" xml-lang="en-US">Function CalIsLeapYear(</paragraph>
+ <paragraph role="bascode" id="par_id401529062200648"
xml-lang="en-US" localize="false">ByVal iYear as Integer) as Boolean</paragraph>
+ </bascode>
</section>
<bookmark xml-lang="en-US" branch="index" id="bm_id21529062611375">
<bookmark_value>BASIC Tools library;ModuleControl
module</bookmark_value>
@@ -781,248 +401,130 @@
<section id="modulecontrols_module">
<paragraph role="heading" id="hd_id451529005764422" level="2"
xml-lang="en-US"><item type="literal">ModuleControls</item> Module</paragraph>
<paragraph role="paragraph" id="par_id841529064645990"
xml-lang="en-US">Functions and subroutines for module control.</paragraph>
- <table id="Tabela1">
- <tablerow>
- <tablecell>
- <paragraph id="par_id261529006338185" role="tablehead"
xml-lang="en-US" localize="false"><embedvar
href="text/sbasic/shared/03/lib_tools.xhp#macro_name"
markup="ignore"/></paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id581529006338185" role="tablehead"
xml-lang="en-US" localize="false"><embedvar
href="text/sbasic/shared/03/lib_tools.xhp#call_param"
markup="ignore"/></paragraph>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061520180728405758" role="bascode"
localize="false" xml-lang="en-US">GetControlShape</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061520180728404186"
role="tablecontent" localize="false" xml-lang="en-US">' Gets the Shape of a
Control( e. g. to reset the size or Position of the control</paragraph>
- <paragraph id="par_id061520180728405899"
role="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph>
- <paragraph id="par_id061520180728401929"
role="tablecontent" localize="false" xml-lang="en-US">' The 'oContainer' is the
Document or a specific sheet of a Calc - Document</paragraph>
- <paragraph id="par_id061520180728406561"
role="tablecontent" localize="false" xml-lang="en-US">' 'CName' is the Name of
the Control</paragraph>
- <bascode>
- <paragraph id="par_id061520180728403658"
role="bascode" localize="false" xml-lang="en-US">Function
GetControlShape(</paragraph>
- <paragraph role="bascode" id="par_id731529060754496"
xml-lang="en-US" localize="false">oContainer as Object,</paragraph>
- <paragraph role="bascode" id="par_id571529060764136"
xml-lang="en-US" localize="false">CName as String)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061520180728402154" role="bascode"
localize="false" xml-lang="en-US">getControlView</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061520180728406447"
role="tablecontent" localize="false" xml-lang="en-US">' Returns the View of a
Control</paragraph>
- <paragraph id="par_id061520180728405250"
role="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph>
- <paragraph id="par_id061520180728407354"
role="tablecontent" localize="false" xml-lang="en-US">' The 'oContainer' is the
Document or a specific sheet of a Calc - Document</paragraph>
- <paragraph id="par_id061520180728407546"
role="tablecontent" localize="false" xml-lang="en-US">' The 'oController' is
always directly attached to the Document</paragraph>
- <paragraph id="par_id061520180728401894"
role="tablecontent" localize="false" xml-lang="en-US">' 'CName' is the Name of
the Control</paragraph>
- <bascode>
- <paragraph id="par_id061520180728405914"
role="bascode" localize="false" xml-lang="en-US">Function
getControlView(</paragraph>
- <paragraph role="bascode" id="par_id431529060800677"
xml-lang="en-US" localize="false">oContainer , </paragraph>
- <paragraph role="bascode" id="par_id471529060805433"
xml-lang="en-US" localize="false">oController as Object, </paragraph>
- <paragraph role="bascode" id="par_id501529060820866"
xml-lang="en-US" localize="false">CName as String) as Object</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061520180728409398" role="bascode"
localize="false" xml-lang="en-US">DisposeControl</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061520180728406445"
role="tablecontent" localize="false" xml-lang="en-US">' Parameters:</paragraph>
- <paragraph id="par_id061520180728405024"
role="tablecontent" localize="false" xml-lang="en-US">' The 'oContainer' is the
Document or a specific sheet of a Calc - Document</paragraph>
- <paragraph id="par_id061520180728403834"
role="tablecontent" localize="false" xml-lang="en-US">' 'CName' is the Name of
the Control</paragraph>
- <bascode>
- <paragraph id="par_id061520180728406007"
role="bascode" localize="false" xml-lang="en-US">Function
DisposeControl(</paragraph>
- <paragraph role="bascode" id="par_id161529060860526"
xml-lang="en-US" localize="false">oContainer as Object, </paragraph>
- <paragraph role="bascode" id="par_id311529060865820"
xml-lang="en-US" localize="false">CName as String) as Boolean</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061520180728401986" role="bascode"
localize="false" xml-lang="en-US">GetControlGroupModel</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id061520180728404727"
role="tablecontent" localize="false" xml-lang="en-US">' Returns a sequence of a
group of controls like option buttons or checkboxes</paragraph>
- <paragraph id="par_id061520180728404702"
role="tablecontent" localize="false" xml-lang="en-US">' The 'oContainer' is the
Document or a specific sheet of a Calc - Document</paragraph>
- <paragraph id="par_id061520180728402498"
role="tablecontent" localize="false" xml-lang="en-US">' 'sGroupName' is the
Name of the Controlgroup</paragraph>
- <bascode>
- <paragraph id="par_id061520180728405097"
role="bascode" localize="false" xml-lang="en-US">Function
GetControlGroupModel(</paragraph>
- <paragraph role="bascode" id="par_id271529060883844"
xml-lang="en-US" localize="false">oContainer as Object, </paragraph>
- <paragraph role="bascode" id="par_id131529060888366"
xml-lang="en-US" localize="false">sGroupName as String )</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
- <tablecell>
- <paragraph id="par_id061520180728404995" role="bascode"
localize="false" xml-lang="en-US">GetRefValue</paragraph>
- </tablecell>
- <tablecell>
- <paragraph id="par_id06152018072840427"
role="tablecontent" localize="false" xml-lang="en-US">' Returns the
Referencevalue of a group of e.g. option buttons or check boxes</paragraph>
- <paragraph id="par_id061520180728401645"
role="tablecontent" localize="false" xml-lang="en-US">' 'oControlGroup' is a
sequence of the Control objects</paragraph>
- <bascode>
- <paragraph id="par_id061520180728405216"
role="bascode" localize="false" xml-lang="en-US">Function
GetRefValue(</paragraph>
- <paragraph role="bascode" id="par_id311529060906785"
xml-lang="en-US" localize="false">oControlGroup() as Object)</paragraph>
- </bascode>
- </tablecell>
- </tablerow>
- <tablerow>
... etc. - the rest is truncated
