blob: 54e4a7dc532369f87e49ace79a1dfd2815fadadb (
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
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
|
<?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 https://mozilla.org/MPL/2.0/.
*
-->
<meta>
<topic id="textsbasicsharedvba_objectsxml" indexer="include" status="PUBLISH">
<title id="tit" >VBA Supported Objects</title>
<filename>/text/sbasic/shared/vba_objects.xhp</filename>
</topic>
</meta>
<body>
<section id="exclusive_vba_objects">
<bookmark branch="index" id="bm_id051920170350145208">
<bookmark_value>VBA Model;Introduction</bookmark_value>
<bookmark_value>VBA Model;Supported objects</bookmark_value>
</bookmark>
<h1 id="hd_id051820170313205718"><variable id="Title"><link href="text/sbasic/shared/vba_objects.xhp">VBA supported Data Model</link></variable></h1>
<paragraph id="par_id051820170314436068" role="paragraph">%PRODUCTNAME Basic adds this set of functionalities when VBA Office support is active.</paragraph>
</section>
<paragraph id="hd_id051820170407499827" role="paragraph">These exclusive %PRODUCTNAME VBA objects properties and methods are enabled when:</paragraph>
<list type="unordered">
<listitem>
<paragraph id="par_id731719825012469" role="listitem">A Basic module is set with <literal>VBAModule</literal> special attribute.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id851719825107422" role="listitem"><item type="literal">Option VBASupport 1</item> compiler statement is placed before the first macro of the VBA Basic module.</paragraph>
</listitem>
</list>
<paragraph role="paragraph" id="par_id201719827126856">A few VBA objects are supported for <link href="text/sbasic/shared/vba_objects.xhp#xlsm">Excel</link>, <link href="text/sbasic/shared/vba_objects.xhp#pptm">Powerpoint</link> and <link href="text/sbasic/shared/vba_objects.xhp#docm">Word</link> application files. Limited properties and methods are available for VBA objects.</paragraph>
<embed href="text/shared/need_help.xhp#needhelp"/>
<section id="VBACommon">
<bookmark branch="index" id="bm_id71543455697570">
<bookmark_value>VBA Model;Err object</bookmark_value>
</bookmark>
<h2 id="hd_id31543446449360">Common objects</h2>
</section>
<comment> MSOffice Excel --------------------------------------------------------------------------------------</comment>
<h2 id="par_id051820170355592581">Excel Objects, Properties and Methods</h2>
<table id="tab_id801719842343187">
<tablerow>
<tablecell colspan="3">
<paragraph id="par_id981719842343187" role="tablehead">Excel supported VBA objects</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell><paragraph id="par_id761719842343187" role="tablecontent" localize="false">
<link href="text/sbasic/shared/vba_objects.xhp#xlsApplication">Application</link><br/>
<link href="text/sbasic/shared/vba_objects.xhp#xlsColumns">Columns</link><br/>
</paragraph></tablecell>
<tablecell><paragraph id="par_id951719842343187" role="tablecontent" localize="false">
<link href="text/sbasic/shared/vba_objects.xhp#xlsRange">Range</link><br/>
<link href="text/sbasic/shared/vba_objects.xhp#xlsRows">Rows</link><br/>
</paragraph></tablecell>
<tablecell><paragraph id="par_id141719842343187" role="tablecontent" localize="false">
<link href="text/sbasic/shared/vba_objects.xhp#xlsWorkbook">Workbook</link><br/>
<link href="text/sbasic/shared/vba_objects.xhp#xlsWorksheet">Worksheet</link><br/>
</paragraph></tablecell>
</tablerow>
</table>
<section id="xlsApplication">
<bookmark branch="index" id="bm_id051920170357078705">
<bookmark_value>VBA Excel Model;Application</bookmark_value>
</bookmark>
<h3 id="hd_id61719826422710">Application</h3>
<paragraph role="paragraph" id="par_id641719824037432"><emph>Properties</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id341719823872468" role="listitem" localize="false">ActiveCell : <link href="text/sbasic/shared/vba_objects.xhp#xlsRange">Range</link></paragraph></listitem>
<listitem><paragraph id="par_id341719834972468" role="listitem" localize="false">ActiveSheet : <link href="text/sbasic/shared/vba_objects.xhp#xlsWoksheet">Worksheet</link></paragraph></listitem>
<listitem><paragraph id="par_id341820823872468" role="listitem" localize="false">ActiveWorkbook : <link href="text/sbasic/shared/vba_objects.xhp#xlsWorkbook">Workbook</link></paragraph></listitem>
<listitem><paragraph id="par_id452719823872468" role="listitem" localize="false">DefaultFilePath : String</paragraph></listitem>
<listitem><paragraph id="par_id563719823872468" role="listitem" localize="false">DisplayAlerts : Boolean</paragraph></listitem>
<listitem><paragraph id="par_id674719823872468" role="listitem" localize="false">LibraryPath : String</paragraph></listitem>
<listitem><paragraph id="par_id675829823872468" role="listitem" localize="false">Name : String</paragraph></listitem>
<listitem><paragraph id="par_id785719823872468" role="listitem">PathSeparator : String - see <link href="text/sbasic/shared/GetPathSeparator.xhp">GetPathSeparator</link> function</paragraph></listitem>
</list>
<paragraph role="paragraph" id="par_id281719824053043"><emph>Methods</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id491719835275851" role="listitem">GetOpenFileName() As Variant - Returns <literal>False</literal> if dialog canceled.</paragraph></listitem>
<listitem><paragraph id="par_id491719824275851" role="listitem" localize="false">Quit</paragraph></listitem>
</list>
</section>
<section id="xlsCell">
<h3 id="hd_id361719826690873">Columns</h3>
<paragraph role="paragraph" id="par_id811719824767080"><emph>Properties</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id501719825375862" role="listitem" localize="false">Address : String</paragraph></listitem>
</list>
<paragraph role="paragraph" id="par_id561719824768137"><emph>Methods</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id141719826728738" role="listitem" localize="false">Item(ndx : Variant) : Column</paragraph></listitem>
</list>
</section>
<section id="xlsRange">
<bookmark branch="index" id="bm_id051920181457078705">
<bookmark_value>VBA Excel Model;Range</bookmark_value>
</bookmark>
<h3 id="hd_id841719839364374" localize="false">Range</h3>
<paragraph role="paragraph" id="par_id851719824771480"><emph>Properties</emph></paragraph>
<paragraph role="paragraph" id="par_id591719824772015"><emph>Methods</emph></paragraph>
<list type="unordered">
<listitem>
<paragraph id="par_id751720021450554" role="listitem" localize="false"><variable id="ExportAsFixedFormat"><link href="text/sbasic/shared/exportasfixedformat.xhp">ExportAsFixedFormat</link>(Optional Type : Integer = xlTypePDF, Optional FileName : String, Optional Quality : Integer = xlQualityStandard, Optional IncludeDocProperties : Boolean, Optional IgnorePrintAreas = Boolean, Optional OpenAfterPublish : Boolean)</variable></paragraph>
</listitem>
</list>
</section>
<section id="xlsRows">
<bookmark branch="index" id="bm_id051920181457078706">
<bookmark_value>VBA Excel Model;Rows</bookmark_value>
</bookmark>
<h3 id="hd_id952719839364374" localize="false">Rows</h3>
<paragraph role="paragraph" id="par_id851719824782580"><emph>Properties</emph></paragraph>
<paragraph role="paragraph" id="par_id591719824883015"><emph>Methods</emph></paragraph>
</section>
<section id="xlsWorkbook">
<bookmark branch="index" id="bm_id051920181457078707">
<bookmark_value>VBA Excel Model;Workbook</bookmark_value>
</bookmark>
<h3 id="hd_id063719839364374" localize="false">Workbook</h3>
<paragraph role="paragraph" id="par_id851710934771480"><emph>Properties</emph></paragraph>
<paragraph role="paragraph" id="par_id591710934772015"><emph>Methods</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id252719827838738" role="listitem" localize="false"><embedvar href="text/sbasic/shared/vba_objects.xhp#ExportAsFixedFormat"/></paragraph></listitem>
</list>
</section>
<section id="xlsWorksheet">
<bookmark branch="index" id="bm_id051920181457078708">
<bookmark_value>VBA Excel Model;Worksheet</bookmark_value>
</bookmark>
<h3 id="hd_id174719839364374" localize="false">Worksheet</h3>
<paragraph role="paragraph" id="par_id862810934771480"><emph>Properties</emph></paragraph>
<paragraph role="paragraph" id="par_id591721034772015"><emph>Methods</emph></paragraph>
<list type="unordered">
<listitem><paragraph id="par_id252820927838738" role="listitem" localize="false"><embedvar href="text/sbasic/shared/vba_objects.xhp#ExportAsFixedFormat"/></paragraph></listitem>
</list></section>
<comment> MSOffice Powerpoint ---------------------------------------------------------------------------------</comment>
<bookmark branch="index" id="bm_id051920170358002074">
<bookmark_value>VBA Powerpoint Model;Application</bookmark_value>
</bookmark>
<h2 id="par_id051820170356006501">PowerPoint Objects, Properties and Methods</h2>
<comment> MSOffice Word ---------------------------------------------------------------------------------------</comment>
<bookmark branch="index" id="bm_id051920170359045662">
<bookmark_value>VBA Word;Application</bookmark_value>
</bookmark>
<h2 id="hd_id051920170347039686">Word Objects, Properties and Methods</h2>
<section id="relatedtopics">
<paragraph id="par_id051720170424259343" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/vbasupport.xhp">VBA support in %PRODUCTNAME</link></paragraph>
<paragraph id="par_id051720171119254111" role="paragraph" xml-lang="en-US"><link href="text/shared/optionen/01130100.xhp">VBA Properties</link></paragraph>
<embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/>
<embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/>
</section>
</body>
</helpdocument>
|
