summaryrefslogtreecommitdiff
path: root/helpcontent2/source/text/sbasic/shared/01040000.xhp
blob: e6084ada87acf60fecb88283a1e3c3b9ff81ed34 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<?xml version="1.0" encoding="UTF-8"?>


<!--
 ***********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: 01040000.xhp,v $
 * $Revision: 1.12 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************
 -->
	
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared01040000xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Event-Driven Macros</title>
<filename>/text/sbasic/shared/01040000.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2007-01-31T11:55:04">converted from old format - fpe
dedr: fixed #i30797#</lastedited>
</history>
</meta>
<body>
<section id="weitere">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154581"><bookmark_value>deleting; macro assignments to events</bookmark_value>
<bookmark_value>macros; assigning to events</bookmark_value>
<bookmark_value>assigning macros to events</bookmark_value>
<bookmark_value>events; assigning macros</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3147348" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/01040000.xhp" name="Event-Driven Macros">Event-Driven Macros</link></paragraph>
<paragraph role="paragraph" id="par_id3146120" xml-lang="en-US" l10n="U" oldref="2">This section describes how to assign Basic programs to program events.</paragraph>
</section>
<paragraph role="paragraph" id="par_id3149263" xml-lang="en-US" l10n="U" oldref="4">You can automatically execute a macro when a specified software event occurs by assigning the desired macro to the event. The following table provides an overview of program events and at what point an assigned macro is executed.</paragraph>
<table id="tbl_id3148646">
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablehead" id="par_id3148455" xml-lang="en-US" l10n="U" oldref="5">Event</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablehead" id="par_id3145799" xml-lang="en-US" l10n="U" oldref="6">An assigned macro is executed...</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3149379" xml-lang="en-US" l10n="U" oldref="7">Program Start</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150715" xml-lang="en-US" l10n="U" oldref="8">... after a $[officename] application is started.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3146914" xml-lang="en-US" l10n="U" oldref="9">Program End</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3153765" xml-lang="en-US" l10n="U" oldref="10">...before a $[officename] application is terminated.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3145150" xml-lang="en-US" l10n="U" oldref="11">Create Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3163808" xml-lang="en-US" l10n="U" oldref="12">...after a new document is created with <emph>File - New</emph> or with the <emph>New</emph> icon.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3145790" xml-lang="en-US" l10n="U" oldref="13">Open Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3154572" xml-lang="en-US" l10n="U" oldref="14">...after a document is opened with <emph>File - Open</emph> or with the <emph>Open</emph> icon.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3153266" xml-lang="en-US" l10n="U" oldref="15">Save Document As</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150208" xml-lang="en-US" l10n="U" oldref="16">...before a document is saved under a specified name (with <emph>File - Save As</emph>, or with <emph>File - Save</emph> or the <emph>Save</emph> icon, if a document name has not yet been specified).</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3158215" xml-lang="en-US" l10n="U" oldref="43">Document has been saved as</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150980" xml-lang="en-US" l10n="U" oldref="44">... after a document was saved under a specified name (with <emph>File - Save As</emph>, or with <emph>File - Save</emph> or with the <emph>Save</emph> icon, if a document name has not yet been specified).</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150519" xml-lang="en-US" l10n="U" oldref="17">Save Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3155529" xml-lang="en-US" l10n="U" oldref="18">...before a document is saved with <emph>File - Save</emph> or the <emph>Save</emph> icon, provided that a document name has already been specified.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3149404" xml-lang="en-US" l10n="U" oldref="45">Document has been saved</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3151332" xml-lang="en-US" l10n="U" oldref="46">...after a document is saved with <emph>File - Save</emph> or the <emph>Save</emph> icon, provided that a document name has already been specified.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3159171" xml-lang="en-US" l10n="U" oldref="19">Close Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3146868" xml-lang="en-US" l10n="U" oldref="20">...before a document is closed.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3159097" xml-lang="en-US" l10n="U" oldref="47">Document is being closed</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3148606" xml-lang="en-US" l10n="U" oldref="48">...after a document was closed. Note that the "Save Document" event may also occur when the document is saved before closing.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3144772" xml-lang="en-US" l10n="U" oldref="21">Activate Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3149442" xml-lang="en-US" l10n="U" oldref="22">...after a document is brought to the foreground.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150888" xml-lang="en-US" l10n="U" oldref="23">Deactivate Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3154060" xml-lang="en-US" l10n="U" oldref="24">...after another document is brought to the foreground.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3152384" xml-lang="en-US" l10n="U" oldref="25">Print Document</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3152873" xml-lang="en-US" l10n="U" oldref="26">...after the <emph>Print</emph> dialog is closed, but before the actual print process begins.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3159227" xml-lang="en-US" l10n="U" oldref="49">JavaScript run-time error</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3145362" xml-lang="en-US" l10n="U" oldref="50">...when a JavaScript run-time error occurs.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3154767" xml-lang="en-US" l10n="U" oldref="27">Print Mail Merge</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3153555" xml-lang="en-US" l10n="U" oldref="28">...after the <emph>Print</emph> dialog is closed, but before the actual print process begins. This event occurs for each copy printed.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3156366" xml-lang="en-US" l10n="U" oldref="51">Change of the page count</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3154627" xml-lang="en-US" l10n="U" oldref="52">...when the page count changes.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3154737" xml-lang="en-US" l10n="U" oldref="53">Message received</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="tablecontent" id="par_id3150952" xml-lang="en-US" l10n="U" oldref="54">...if a message was received.</paragraph>
</tablecell>
</tablerow>
</table>

<paragraph role="heading" id="hd_id3153299" xml-lang="en-US" level="2" l10n="U" oldref="30">Assigning a Macro to an Event</paragraph>
<list type="ordered">
<listitem>
<paragraph role="listitem" id="par_id3147244" xml-lang="en-US" l10n="U" oldref="31">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3146098" xml-lang="en-US" l10n="CHG" oldref="55">Select whether you want the assignment to be globally valid or just valid in the current document in the <emph>Save In</emph> listbox.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3150431" xml-lang="en-US" l10n="U" oldref="32">Select the event from the <emph>Event</emph> list.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3148742" xml-lang="en-US" l10n="CHG" oldref="33">Click <emph>Macro</emph> and select the macro to be assigned to the selected event.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3146321" xml-lang="en-US" l10n="CHG" oldref="35">Click <emph>OK</emph> to assign the macro.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3147414" xml-lang="en-US" l10n="U" oldref="56">Click <emph>OK</emph> to close the dialog.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="hd_id3154581" xml-lang="en-US" level="2" l10n="U" oldref="36">Removing the Assignment of a Macro to an Event</paragraph>
<list type="ordered">
<listitem>
<paragraph role="listitem" id="par_id3146883" xml-lang="en-US" l10n="U" oldref="57">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3155909" xml-lang="en-US" l10n="CHG" oldref="58">Select whether you want to remove a global assignment or an assignment that is just valid in the current document by selecting the option in the <emph>Save In</emph> listbox.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3159129" xml-lang="en-US" l10n="U" oldref="59">Select the event that contains the assignment to be removed from the <emph>Event</emph> list.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3149143" xml-lang="en-US" l10n="U" oldref="37">Click <emph>Remove</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3149351" xml-lang="en-US" l10n="U" oldref="60">Click <emph>OK</emph> to close the dialog.</paragraph>
</listitem>
</list>
</body>
</helpdocument>