summaryrefslogtreecommitdiffstats
path: root/source/text/sbasic/shared/03132200.xhp
blob: e01e2baf5cddf2d19534cef489b1747c48c09ef5 (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->

<meta>
  <topic id="textsbasicshared03132200xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">ThisComponent Statement</title>
    <filename>/text/sbasic/shared/03132200.xhp</filename>
  </topic>
</meta>

<body>

<section id="thiscomponent">
<bookmark xml-lang="en-US" branch="index" id="bm_id3155342">
  <bookmark_value>ThisComponent property</bookmark_value>
  <bookmark_value>components;addressing</bookmark_value>
</bookmark>

<paragraph id="hd_id3155342" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03132200.xhp" name="ThisComponent Statement">ThisComponent Statement</link></paragraph>
<paragraph id="par_id3154923" role="paragraph" xml-lang="en-US">Addresses the active component so that its properties can be read and set. ThisComponent is used from document Basic, where it represents the document the Basic belongs to. The type of object accessed by ThisComponent depends on the document type.<comment>see i60932</comment></paragraph>
</section>

<paragraph id="hd_id3154346" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3151056" role="bascode" localize="false" xml-lang="en-US">ThisComponent</paragraph>
</bascode>

<paragraph id="hd_id3154940" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341584928" role="bascode" localize="false" xml-lang="en-US">Sub Main</paragraph>
<paragraph id="par_id3154123" role="bascode" xml-lang="en-US">' updates the "Table of Contents" in a text doc</paragraph>
<paragraph id="par_idm1341581904" role="bascode" localize="false" xml-lang="en-US">Dim allindexes, index As Object</paragraph>
<paragraph id="par_idm1341580656" role="bascode" localize="false" xml-lang="en-US">    allindexes = ThisComponent.getDocumentIndexes()</paragraph>
<paragraph id="par_id3153194" role="bascode" xml-lang="en-US">    index = allindexes.getByName("Table of Contents1")</paragraph>
<paragraph id="par_id3156422" role="bascode" xml-lang="en-US">    ' use the default name for Table of Contents and a 1</paragraph>
<paragraph id="par_idm1341575840" role="bascode" localize="false" xml-lang="en-US">    index.update()</paragraph>
<paragraph id="par_idm1341574608" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>