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
|
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
***********************************************************************
*
* 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: scripting.xhp,v $
* $Revision: 1.17.4.1 $
*
* 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.
*
************************************************************************
-->
<meta>
<topic id="textsharedguidescriptingxml" indexer="include">
<title id="tit" xml-lang="en-US">Scripting %PRODUCTNAME</title>
<filename>/text/shared/guide/scripting.xhp</filename>
</topic>
</meta>
<body>
<bookmark xml-lang="en-US" branch="index" id="bm_id5277565"><bookmark_value>assigning scripts</bookmark_value>
<bookmark_value>programming;scripting</bookmark_value>
<bookmark_value>form controls;assigning macros</bookmark_value>
<bookmark_value>pictures;assigning macros</bookmark_value>
<bookmark_value>hyperlinks;assigning macros</bookmark_value>
<bookmark_value>shortcut keys;assigning macros</bookmark_value>
<bookmark_value>controls;assigning macros (Basic)</bookmark_value>
<bookmark_value>menus;assigning macros</bookmark_value>
<bookmark_value>events;assigning scripts</bookmark_value>
</bookmark><comment>MW deleted "programming;...", "scripting in programming", "BeanShell scripting", "Basic;..." and "java;..."</comment><comment>MW added "controls;..", "menus;..." and "events;..."</comment>
<paragraph role="heading" id="par_idN1070A" xml-lang="en-US" level="1" l10n="NEW"><variable id="scripting"><link href="text/shared/guide/scripting.xhp">Assigning Scripts in %PRODUCTNAME</link>
</variable></paragraph>
<paragraph role="paragraph" id="par_idN10728" xml-lang="en-US" l10n="NEW">You can assign custom scripts (macros) to menu items, icons, dialog controls, and events in %PRODUCTNAME.</paragraph>
<paragraph role="paragraph" id="par_idN1072B" xml-lang="en-US" l10n="NEW">%PRODUCTNAME internally supports the following scripting languages:</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN10731" xml-lang="en-US" l10n="NEW">%PRODUCTNAME Basic</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10739" xml-lang="en-US" l10n="NEW">JavaScript</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN1073D" xml-lang="en-US" l10n="CHG">BeanShell</paragraph>
</listitem>
</list>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_id6797082" xml-lang="en-US" l10n="CHG">Python (not included with all distributions)<comment>i50641</comment><comment>removed switch, added text</comment></paragraph>
</listitem>
</list>
<paragraph role="paragraph" id="par_idN1091F" xml-lang="en-US" l10n="NEW">In addition, developers can use high-level languages, for example Java programming language, to control %PRODUCTNAME externally. See the API project at OpenOffice.org.</paragraph>
<paragraph role="heading" id="par_idN10751" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a new menu entry</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN10758" xml-lang="en-US" l10n="NEW">Choose <emph>Tools - Customize</emph>, and click the <emph>Menus</emph> tab.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN1093D" xml-lang="en-US" l10n="NEW">Click <emph>Add</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10760" xml-lang="en-US" l10n="NEW">In the <emph>Category</emph> list box, scroll down and open the "%PRODUCTNAME Macros" entry.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10768" xml-lang="en-US" l10n="NEW">You see entries for "%PRODUCTNAME Macros" (scripts in the share directory of your %PRODUCTNAME installation), "My Macros" (scripts in the user directory), and the current document. Open any one of them to see the supported scripting languages.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN1076C" xml-lang="en-US" l10n="NEW">Open any scripting language entry to see the available scripts. Select a script.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10770" xml-lang="en-US" l10n="NEW">A list of the script functions appears in the <emph>Commands</emph> list box. Select a function.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10778" xml-lang="en-US" l10n="NEW">Click <emph>Add</emph> to create a new menu assignment. The new menu entry appears in the <emph>Entries</emph> list box.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN10783" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a key combination</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN10787" xml-lang="en-US" l10n="NEW">Choose <emph>Tools - Customize - Keyboard</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A59" xml-lang="en-US" l10n="NEW">In the <emph>Category</emph> list box, scroll down and open the "%PRODUCTNAME Macros" entry.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A61" xml-lang="en-US" l10n="NEW">You see entries for "%PRODUCTNAME Macros" (scripts in the share directory of your %PRODUCTNAME installation), "My Macros" (scripts in the user directory), and the current document. Open any one of them to see the supported scripting languages.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A65" xml-lang="en-US" l10n="NEW">Open any scripting language entry to see the available scripts. Select any script.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A69" xml-lang="en-US" l10n="NEW">A list of the script functions will appear in the <emph>Commands</emph> list box. Select any function.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A71" xml-lang="en-US" l10n="NEW">Click the option button for %PRODUCTNAME or Writer (or whichever application is currently open). </paragraph>
<paragraph role="paragraph" id="par_idN10A74" xml-lang="en-US" l10n="NEW">Selecting the option button sets the scope of the new key combination to be applicable in all of %PRODUCTNAME or only in documents of the current module.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A78" xml-lang="en-US" l10n="NEW">Select a key combination from the <emph>Shortcut keys</emph> list box and click <emph>Modify</emph>.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN1078A" xml-lang="en-US" level="2" l10n="NEW">To assign a script to an event</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN1078E" xml-lang="en-US" l10n="NEW">Choose <emph>Tools - Customize - Events</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A16" xml-lang="en-US" l10n="NEW">Click <emph>Macro</emph> button.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10A9E" xml-lang="en-US" l10n="NEW">In the <emph>Library</emph> list box, scroll down and open the "%PRODUCTNAME Macros" entry.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AA6" xml-lang="en-US" l10n="NEW">You see entries for "%PRODUCTNAME Macros" (scripts in the share directory of your %PRODUCTNAME installation), "My Macros" (scripts in the user directory), and the current document. Open any one of them to see the supported scripting languages.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AAA" xml-lang="en-US" l10n="NEW">Open any scripting language entry to see the available scripts. Select any script.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AAE" xml-lang="en-US" l10n="NEW">A list of the script functions will appear in the <emph>Assigned Action</emph> list box. Select any function.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AB6" xml-lang="en-US" l10n="NEW">Select to save in %PRODUCTNAME or current document.</paragraph>
<paragraph role="paragraph" id="par_idN10AB9" xml-lang="en-US" l10n="CHG">This sets the scope of the new event assignment to be applicable in all of %PRODUCTNAME or only in documents of the current module.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10ABD" xml-lang="en-US" l10n="NEW">Select an event from the list and click <emph>OK</emph>.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN10791" xml-lang="en-US" level="2" l10n="NEW">To assign a script to an event for an embedded object</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN10795" xml-lang="en-US" l10n="NEW">Select the embedded object, for example a chart, in your document.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10ADB" xml-lang="en-US" l10n="NEW">Choose <emph>Format - Frame/Object - Macro</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10ADF" xml-lang="en-US" l10n="NEW">In the <emph>Macros</emph> list box, open the %PRODUCTNAME Scripts entry.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AE7" xml-lang="en-US" l10n="NEW">You see entries for share (scripts in the share directory of your %PRODUCTNAME installation), user (scripts in the user directory), and the current document. Open any one of them to see the supported scripting languages.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AEB" xml-lang="en-US" l10n="NEW">Open any scripting language entry to see the available scripts. Select any script.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AEF" xml-lang="en-US" l10n="NEW">A list of the script functions will appear in the <emph>Existing macros in</emph> list box. Select any function.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10AF7" xml-lang="en-US" l10n="NEW">Select an event from the list and click <emph>OK</emph>.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN10798" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a hyperlink</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN1079C" xml-lang="en-US" l10n="NEW">Position the cursor inside the hyperlink. </paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B15" xml-lang="en-US" l10n="NEW">Choose <emph>Insert - Hyperlink</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B19" xml-lang="en-US" l10n="NEW">Click the <emph>Events</emph> button.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B21" xml-lang="en-US" l10n="NEW">Select and assign as stated above.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN1079F" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a graphic</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN107A3" xml-lang="en-US" l10n="NEW">Select the graphic in your document. </paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B3B" xml-lang="en-US" l10n="CHG">Choose <emph>Format - Picture - Macro</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B3F" xml-lang="en-US" l10n="NEW">Select and assign as stated above.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN107A6" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a form control</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN107AA" xml-lang="en-US" l10n="CHG">Insert a form control, for example a button: Open the Form Controls toolbar, click the <emph>Push Button</emph> icon, drag open a button on your document.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B59" xml-lang="en-US" l10n="CHG">With the form control selected, click <emph>Control</emph> on the Form Controls toolbar.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B5D" xml-lang="en-US" l10n="NEW">Click the <emph>Events</emph> tab of the Properties dialog.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B61" xml-lang="en-US" l10n="NEW">Click one of the <emph>...</emph> buttons to open a dialog where you can assign a script to the selected event.</paragraph>
</listitem>
</list>
<paragraph role="heading" id="par_idN107AD" xml-lang="en-US" level="2" l10n="NEW">To assign a script to a control in the %PRODUCTNAME Basic dialog</paragraph>
<list type="ordered">
<listitem>
<paragraph role="paragraph" id="par_idN107B1" xml-lang="en-US" l10n="NEW">Open the %PRODUCTNAME Basic dialog editor, then create a dialog with a control on it.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B7F" xml-lang="en-US" l10n="NEW">Right-click the control, then choose <emph>Properties</emph>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B87" xml-lang="en-US" l10n="NEW">Click the <emph>Events</emph> tab of the Properties dialog.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" id="par_idN10B8B" xml-lang="en-US" l10n="NEW">Click one of the <emph>...</emph> buttons to open a dialog where you can assign a script to the selected event.</paragraph>
</listitem>
</list>
</body>
</helpdocument>
|
