1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?> 2*b1cdbd2cSJim Jagielski<helpdocument version="1.0"> 3*b1cdbd2cSJim Jagielski 4*b1cdbd2cSJim Jagielski<!--*********************************************************** 5*b1cdbd2cSJim Jagielski * 6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 7*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 8*b1cdbd2cSJim Jagielski * distributed with this work for additional information 9*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 12*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 13*b1cdbd2cSJim Jagielski * 14*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 15*b1cdbd2cSJim Jagielski * 16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 21*b1cdbd2cSJim Jagielski * under the License. 22*b1cdbd2cSJim Jagielski * 23*b1cdbd2cSJim Jagielski ***********************************************************--> 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski<meta> 29*b1cdbd2cSJim Jagielski <topic id="textsbasicshared01040000xml" indexer="include" status="PUBLISH"> 30*b1cdbd2cSJim Jagielski <title xml-lang="en-US" id="tit">Event-Driven Macros</title> 31*b1cdbd2cSJim Jagielski <filename>/text/sbasic/shared/01040000.xhp</filename> 32*b1cdbd2cSJim Jagielski </topic> 33*b1cdbd2cSJim Jagielski </meta> 34*b1cdbd2cSJim Jagielski <body> 35*b1cdbd2cSJim Jagielski <section id="weitere"> 36*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3154581"><bookmark_value>deleting; macro assignments to events</bookmark_value> 37*b1cdbd2cSJim Jagielski <bookmark_value>macros; assigning to events</bookmark_value> 38*b1cdbd2cSJim Jagielski <bookmark_value>assigning macros to events</bookmark_value> 39*b1cdbd2cSJim Jagielski <bookmark_value>events; assigning macros</bookmark_value> 40*b1cdbd2cSJim Jagielski</bookmark> 41*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3147348" role="heading" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/01040000.xhp" name="Event-Driven Macros">Event-Driven Macros</link></paragraph> 42*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146120" role="paragraph" l10n="U" oldref="2">This section describes how to assign Basic programs to program events.</paragraph> 43*b1cdbd2cSJim Jagielski </section> 44*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149263" role="paragraph" 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> 45*b1cdbd2cSJim Jagielski <table id="tbl_id3148646"> 46*b1cdbd2cSJim Jagielski <tablerow> 47*b1cdbd2cSJim Jagielski <tablecell> 48*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3148455" role="tablehead" l10n="U" oldref="5">Event</paragraph> 49*b1cdbd2cSJim Jagielski </tablecell> 50*b1cdbd2cSJim Jagielski <tablecell> 51*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3145799" role="tablehead" l10n="U" oldref="6">An assigned macro is executed...</paragraph> 52*b1cdbd2cSJim Jagielski </tablecell> 53*b1cdbd2cSJim Jagielski </tablerow> 54*b1cdbd2cSJim Jagielski <tablerow> 55*b1cdbd2cSJim Jagielski <tablecell> 56*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149379" role="tablecontent" l10n="U" oldref="7">Program Start</paragraph> 57*b1cdbd2cSJim Jagielski </tablecell> 58*b1cdbd2cSJim Jagielski <tablecell> 59*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150715" role="tablecontent" l10n="U" oldref="8">... after a $[officename] application is started.</paragraph> 60*b1cdbd2cSJim Jagielski </tablecell> 61*b1cdbd2cSJim Jagielski </tablerow> 62*b1cdbd2cSJim Jagielski <tablerow> 63*b1cdbd2cSJim Jagielski <tablecell> 64*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146914" role="tablecontent" l10n="U" oldref="9">Program End</paragraph> 65*b1cdbd2cSJim Jagielski </tablecell> 66*b1cdbd2cSJim Jagielski <tablecell> 67*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153765" role="tablecontent" l10n="U" oldref="10">...before a $[officename] application is terminated.</paragraph> 68*b1cdbd2cSJim Jagielski </tablecell> 69*b1cdbd2cSJim Jagielski </tablerow> 70*b1cdbd2cSJim Jagielski <tablerow> 71*b1cdbd2cSJim Jagielski <tablecell> 72*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3145150" role="tablecontent" l10n="U" oldref="11">Create Document</paragraph> 73*b1cdbd2cSJim Jagielski </tablecell> 74*b1cdbd2cSJim Jagielski <tablecell> 75*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3163808" role="tablecontent" l10n="U" oldref="12">...after a new document is created with <emph>File - New</emph> or with the <emph>New</emph> icon.</paragraph> 76*b1cdbd2cSJim Jagielski </tablecell> 77*b1cdbd2cSJim Jagielski </tablerow> 78*b1cdbd2cSJim Jagielski <tablerow> 79*b1cdbd2cSJim Jagielski <tablecell> 80*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3145790" role="tablecontent" l10n="U" oldref="13">Open Document</paragraph> 81*b1cdbd2cSJim Jagielski </tablecell> 82*b1cdbd2cSJim Jagielski <tablecell> 83*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154572" role="tablecontent" l10n="U" oldref="14">...after a document is opened with <emph>File - Open</emph> or with the <emph>Open</emph> icon.</paragraph> 84*b1cdbd2cSJim Jagielski </tablecell> 85*b1cdbd2cSJim Jagielski </tablerow> 86*b1cdbd2cSJim Jagielski <tablerow> 87*b1cdbd2cSJim Jagielski <tablecell> 88*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153266" role="tablecontent" l10n="U" oldref="15">Save Document As</paragraph> 89*b1cdbd2cSJim Jagielski </tablecell> 90*b1cdbd2cSJim Jagielski <tablecell> 91*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150208" role="tablecontent" 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> 92*b1cdbd2cSJim Jagielski </tablecell> 93*b1cdbd2cSJim Jagielski </tablerow> 94*b1cdbd2cSJim Jagielski <tablerow> 95*b1cdbd2cSJim Jagielski <tablecell> 96*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3158215" role="tablecontent" l10n="U" oldref="43">Document has been saved as</paragraph> 97*b1cdbd2cSJim Jagielski </tablecell> 98*b1cdbd2cSJim Jagielski <tablecell> 99*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150980" role="tablecontent" 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> 100*b1cdbd2cSJim Jagielski </tablecell> 101*b1cdbd2cSJim Jagielski </tablerow> 102*b1cdbd2cSJim Jagielski <tablerow> 103*b1cdbd2cSJim Jagielski <tablecell> 104*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150519" role="tablecontent" l10n="U" oldref="17">Save Document</paragraph> 105*b1cdbd2cSJim Jagielski </tablecell> 106*b1cdbd2cSJim Jagielski <tablecell> 107*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3155529" role="tablecontent" 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> 108*b1cdbd2cSJim Jagielski </tablecell> 109*b1cdbd2cSJim Jagielski </tablerow> 110*b1cdbd2cSJim Jagielski <tablerow> 111*b1cdbd2cSJim Jagielski <tablecell> 112*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149404" role="tablecontent" l10n="U" oldref="45">Document has been saved</paragraph> 113*b1cdbd2cSJim Jagielski </tablecell> 114*b1cdbd2cSJim Jagielski <tablecell> 115*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3151332" role="tablecontent" 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> 116*b1cdbd2cSJim Jagielski </tablecell> 117*b1cdbd2cSJim Jagielski </tablerow> 118*b1cdbd2cSJim Jagielski <tablerow> 119*b1cdbd2cSJim Jagielski <tablecell> 120*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159171" role="tablecontent" l10n="CHG" oldref="19">Document is closing<comment>i104852</comment></paragraph> 121*b1cdbd2cSJim Jagielski </tablecell> 122*b1cdbd2cSJim Jagielski <tablecell> 123*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146868" role="tablecontent" l10n="U" oldref="20">...before a document is closed.</paragraph> 124*b1cdbd2cSJim Jagielski </tablecell> 125*b1cdbd2cSJim Jagielski </tablerow> 126*b1cdbd2cSJim Jagielski <tablerow> 127*b1cdbd2cSJim Jagielski <tablecell> 128*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159097" role="tablecontent" l10n="CHG" oldref="47">Document closed</paragraph> 129*b1cdbd2cSJim Jagielski </tablecell> 130*b1cdbd2cSJim Jagielski <tablecell> 131*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3148606" role="tablecontent" 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> 132*b1cdbd2cSJim Jagielski </tablecell> 133*b1cdbd2cSJim Jagielski </tablerow> 134*b1cdbd2cSJim Jagielski <tablerow> 135*b1cdbd2cSJim Jagielski <tablecell> 136*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3144772" role="tablecontent" l10n="U" oldref="21">Activate Document</paragraph> 137*b1cdbd2cSJim Jagielski </tablecell> 138*b1cdbd2cSJim Jagielski <tablecell> 139*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149442" role="tablecontent" l10n="U" oldref="22">...after a document is brought to the foreground.</paragraph> 140*b1cdbd2cSJim Jagielski </tablecell> 141*b1cdbd2cSJim Jagielski </tablerow> 142*b1cdbd2cSJim Jagielski <tablerow> 143*b1cdbd2cSJim Jagielski <tablecell> 144*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150888" role="tablecontent" l10n="U" oldref="23">Deactivate Document</paragraph> 145*b1cdbd2cSJim Jagielski </tablecell> 146*b1cdbd2cSJim Jagielski <tablecell> 147*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154060" role="tablecontent" l10n="U" oldref="24">...after another document is brought to the foreground.</paragraph> 148*b1cdbd2cSJim Jagielski </tablecell> 149*b1cdbd2cSJim Jagielski </tablerow> 150*b1cdbd2cSJim Jagielski <tablerow> 151*b1cdbd2cSJim Jagielski <tablecell> 152*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3152384" role="tablecontent" l10n="U" oldref="25">Print Document</paragraph> 153*b1cdbd2cSJim Jagielski </tablecell> 154*b1cdbd2cSJim Jagielski <tablecell> 155*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3152873" role="tablecontent" l10n="U" oldref="26">...after the <emph>Print</emph> dialog is closed, but before the actual print process begins.</paragraph> 156*b1cdbd2cSJim Jagielski </tablecell> 157*b1cdbd2cSJim Jagielski </tablerow> 158*b1cdbd2cSJim Jagielski <tablerow> 159*b1cdbd2cSJim Jagielski <tablecell> 160*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159227" role="tablecontent" l10n="U" oldref="49">JavaScript run-time error</paragraph> 161*b1cdbd2cSJim Jagielski </tablecell> 162*b1cdbd2cSJim Jagielski <tablecell> 163*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3145362" role="tablecontent" l10n="U" oldref="50">...when a JavaScript run-time error occurs.</paragraph> 164*b1cdbd2cSJim Jagielski </tablecell> 165*b1cdbd2cSJim Jagielski </tablerow> 166*b1cdbd2cSJim Jagielski <tablerow> 167*b1cdbd2cSJim Jagielski <tablecell> 168*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154767" role="tablecontent" l10n="U" oldref="27">Print Mail Merge</paragraph> 169*b1cdbd2cSJim Jagielski </tablecell> 170*b1cdbd2cSJim Jagielski <tablecell> 171*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153555" role="tablecontent" 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> 172*b1cdbd2cSJim Jagielski </tablecell> 173*b1cdbd2cSJim Jagielski </tablerow> 174*b1cdbd2cSJim Jagielski <tablerow> 175*b1cdbd2cSJim Jagielski <tablecell> 176*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3156366" role="tablecontent" l10n="U" oldref="51">Change of the page count</paragraph> 177*b1cdbd2cSJim Jagielski </tablecell> 178*b1cdbd2cSJim Jagielski <tablecell> 179*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154627" role="tablecontent" l10n="U" oldref="52">...when the page count changes.</paragraph> 180*b1cdbd2cSJim Jagielski </tablecell> 181*b1cdbd2cSJim Jagielski </tablerow> 182*b1cdbd2cSJim Jagielski <tablerow> 183*b1cdbd2cSJim Jagielski <tablecell> 184*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154737" role="tablecontent" l10n="U" oldref="53">Message received</paragraph> 185*b1cdbd2cSJim Jagielski </tablecell> 186*b1cdbd2cSJim Jagielski <tablecell> 187*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150952" role="tablecontent" l10n="U" oldref="54">...if a message was received.</paragraph> 188*b1cdbd2cSJim Jagielski </tablecell> 189*b1cdbd2cSJim Jagielski </tablerow> 190*b1cdbd2cSJim Jagielski </table> 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="hd_id3153299" role="heading" level="2" l10n="U" 193*b1cdbd2cSJim Jagielski oldref="30">Assigning a Macro to an Event</paragraph> 194*b1cdbd2cSJim Jagielski <list type="ordered"> 195*b1cdbd2cSJim Jagielski <listitem> 196*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3147244" role="listitem" l10n="U" oldref="31">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph> 197*b1cdbd2cSJim Jagielski </listitem> 198*b1cdbd2cSJim Jagielski <listitem> 199*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146098" role="listitem" 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> 200*b1cdbd2cSJim Jagielski </listitem> 201*b1cdbd2cSJim Jagielski <listitem> 202*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150431" role="listitem" l10n="U" oldref="32">Select the event from the <emph>Event</emph> list.</paragraph> 203*b1cdbd2cSJim Jagielski </listitem> 204*b1cdbd2cSJim Jagielski <listitem> 205*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3148742" role="listitem" l10n="CHG" oldref="33">Click <emph>Macro</emph> and select the macro to be assigned to the selected event.</paragraph> 206*b1cdbd2cSJim Jagielski </listitem> 207*b1cdbd2cSJim Jagielski <listitem> 208*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146321" role="listitem" l10n="CHG" oldref="35">Click <emph>OK</emph> to assign the macro.</paragraph> 209*b1cdbd2cSJim Jagielski </listitem> 210*b1cdbd2cSJim Jagielski <listitem> 211*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3147414" role="listitem" l10n="U" oldref="56">Click <emph>OK</emph> to close the dialog.</paragraph> 212*b1cdbd2cSJim Jagielski </listitem> 213*b1cdbd2cSJim Jagielski </list> 214*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="hd_id3154581" role="heading" level="2" l10n="U" 215*b1cdbd2cSJim Jagielski oldref="36">Removing the Assignment of a Macro to an Event</paragraph> 216*b1cdbd2cSJim Jagielski <list type="ordered"> 217*b1cdbd2cSJim Jagielski <listitem> 218*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146883" role="listitem" l10n="U" oldref="57">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph> 219*b1cdbd2cSJim Jagielski </listitem> 220*b1cdbd2cSJim Jagielski <listitem> 221*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3155909" role="listitem" 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> 222*b1cdbd2cSJim Jagielski </listitem> 223*b1cdbd2cSJim Jagielski <listitem> 224*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159129" role="listitem" l10n="U" oldref="59">Select the event that contains the assignment to be removed from the <emph>Event</emph> list.</paragraph> 225*b1cdbd2cSJim Jagielski </listitem> 226*b1cdbd2cSJim Jagielski <listitem> 227*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149143" role="listitem" l10n="U" oldref="37">Click <emph>Remove</emph>.</paragraph> 228*b1cdbd2cSJim Jagielski </listitem> 229*b1cdbd2cSJim Jagielski <listitem> 230*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149351" role="listitem" l10n="U" oldref="60">Click <emph>OK</emph> to close the dialog.</paragraph> 231*b1cdbd2cSJim Jagielski </listitem> 232*b1cdbd2cSJim Jagielski </list> 233*b1cdbd2cSJim Jagielski </body> 234*b1cdbd2cSJim Jagielski</helpdocument>