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="textshared0201170202xml" indexer="include" status="PUBLISH"> 30*b1cdbd2cSJim Jagielski <title xml-lang="en-US" id="tit">Events</title> 31*b1cdbd2cSJim Jagielski <filename>/text/shared/02/01170202.xhp</filename> 32*b1cdbd2cSJim Jagielski </topic> 33*b1cdbd2cSJim Jagielski </meta> 34*b1cdbd2cSJim Jagielski <body> 35*b1cdbd2cSJim Jagielski <section id="ereignisse"> 36*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"><bookmark_value>forms; events</bookmark_value> 37*b1cdbd2cSJim Jagielski <bookmark_value>events;in forms</bookmark_value> 38*b1cdbd2cSJim Jagielski</bookmark> 39*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3150499" role="heading" level="1" l10n="U" oldref="1"><link href="text/shared/02/01170202.xhp" name="Events">Events</link></paragraph> 40*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3147043" role="paragraph" l10n="U" oldref="2">The<emph> Events </emph>tab page, allows you to assign a macro to certain events which occur in a form.</paragraph> 41*b1cdbd2cSJim Jagielski </section> 42*b1cdbd2cSJim Jagielski <section id="howtoget"> 43*b1cdbd2cSJim Jagielski <embed href="text/shared/00/00040501.xhp#formulareigenschaftenereignisse"/> 44*b1cdbd2cSJim Jagielski </section> 45*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159233" role="paragraph" l10n="U" oldref="3">To link an event with a macro, first write a macro that contains all the commands to be executed when the event happens. Then assign this macro to the respective event by clicking the <emph>... </emph>button beside the corresponding event. The<emph> Assign Macro </emph>dialog opens, where you can select the macro.</paragraph> 46*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149182" role="paragraph" l10n="U" oldref="29">The following actions can be configured individually, meaning that you can use your own dialogs to depict an action:</paragraph> 47*b1cdbd2cSJim Jagielski <list type="ordered"> 48*b1cdbd2cSJim Jagielski <listitem> 49*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3166460" role="listitem" l10n="U" oldref="30">Displaying an error message,</paragraph> 50*b1cdbd2cSJim Jagielski </listitem> 51*b1cdbd2cSJim Jagielski </list> 52*b1cdbd2cSJim Jagielski <list type="ordered"> 53*b1cdbd2cSJim Jagielski <listitem> 54*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3152996" role="listitem" l10n="U" oldref="31">Confirming a delete process (for data records),</paragraph> 55*b1cdbd2cSJim Jagielski </listitem> 56*b1cdbd2cSJim Jagielski </list> 57*b1cdbd2cSJim Jagielski <list type="ordered"> 58*b1cdbd2cSJim Jagielski <listitem> 59*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153541" role="listitem" l10n="U" oldref="32">Querying parameters,</paragraph> 60*b1cdbd2cSJim Jagielski </listitem> 61*b1cdbd2cSJim Jagielski </list> 62*b1cdbd2cSJim Jagielski <list type="ordered"> 63*b1cdbd2cSJim Jagielski <listitem> 64*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3155261" role="listitem" l10n="U" oldref="33">Checking input when saving a data record.</paragraph> 65*b1cdbd2cSJim Jagielski </listitem> 66*b1cdbd2cSJim Jagielski </list> 67*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153127" role="paragraph" l10n="U" oldref="34">For example, you can issue a "confirm deletion" request such as "Really delete customer xyz?" when deleting a data record.</paragraph> 68*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id0409200920562590" role="note" l10n="NEW">The events that are shown in the Events dialog cannot be edited directly. You can delete an event from the list by pressing the Del key.</paragraph> 69*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3150986" role="paragraph" l10n="U" oldref="4">The following lists and describes all events in a form that can be linked to a macro:</paragraph> 70*b1cdbd2cSJim Jagielski<sort order="asc"> 71*b1cdbd2cSJim Jagielski<section id="reset_update"> 72*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="hd_id3147559" role="heading" level="2" l10n="U" 73*b1cdbd2cSJim Jagielski oldref="17">Before update</paragraph> 74*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149669" role="paragraph" l10n="U" oldref="56"><ahelp hid=".">The Before update event occurs before the control content changed by the user is written into the data source.</ahelp> The linked macro can, for example, prevent this action by returning "FALSE".</paragraph> 75*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_AFTERUPDATE" id="bm_id3154073" localize="false"/> 76*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3153779" role="heading" level="2" l10n="U" 77*b1cdbd2cSJim Jagielski oldref="19">After update</paragraph> 78*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153360" role="paragraph" l10n="U" oldref="57"><ahelp hid="HID_EVT_AFTERUPDATE">The After update event occurs after the control content changed by the user has been written into the data source.</ahelp></paragraph> 79*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_APPROVERESETTED" id="bm_id3154851" localize="false"/> 80*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3157909" role="heading" level="2" l10n="U" 81*b1cdbd2cSJim Jagielski oldref="36">Prior to reset</paragraph> 82*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3155390" role="paragraph" l10n="U" oldref="51"><ahelp hid="HID_EVT_APPROVERESETTED">The<emph> Prior to reset </emph>event occurs before a form is reset.</ahelp> The linked macro can, for example, prevent this action by returning "FALSE".</paragraph> 83*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149236" role="paragraph" l10n="U" oldref="52">A form is reset if one of the following conditions is met:</paragraph> 84*b1cdbd2cSJim Jagielski <list type="ordered"> 85*b1cdbd2cSJim Jagielski <listitem> 86*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149164" role="listitem" l10n="U" oldref="53">The user presses an (HTML) button that is defined as a reset button.</paragraph> 87*b1cdbd2cSJim Jagielski </listitem> 88*b1cdbd2cSJim Jagielski <listitem> 89*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3153666" role="listitem" l10n="U" oldref="54">A new and empty record is created in a form that is linked to a data source. For example, in the last record, the <emph>Next Record</emph> button may be pressed.</paragraph> 90*b1cdbd2cSJim Jagielski </listitem> 91*b1cdbd2cSJim Jagielski </list> 92*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_RESETTED" id="bm_id3152473" localize="false"/> 93*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3156119" role="heading" level="2" l10n="U" 94*b1cdbd2cSJim Jagielski oldref="37">After resetting</paragraph> 95*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3148563" role="paragraph" l10n="U" oldref="55"><ahelp hid="HID_EVT_RESETTED">The<emph> After resetting </emph>event occurs after a form has been reset.</ahelp></paragraph> 96*b1cdbd2cSJim Jagielski </section> 97*b1cdbd2cSJim Jagielski <section id="Section13"> 98*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_SUBMITTED" id="bm_id3147084" localize="false"/> 99*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3150870" role="heading" level="2" l10n="U" 100*b1cdbd2cSJim Jagielski oldref="27">Before submitting</paragraph> 101*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3159152" role="paragraph" l10n="U" oldref="28"><ahelp hid="HID_EVT_SUBMITTED">The<emph> Before submitting </emph>event occurs before the form data is sent.</ahelp></paragraph> 102*b1cdbd2cSJim Jagielski </section> 103*b1cdbd2cSJim Jagielski <section id="Section12"> 104*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_LOADED" id="bm_id3151383" localize="false"/> 105*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3149167" role="heading" level="2" l10n="U" oldref="5">When loading</paragraph> 106*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3156423" role="paragraph" l10n="U" oldref="6"><ahelp hid="HID_EVT_LOADED">The<emph> When loading </emph>event occurs directly after the form has been loaded.</ahelp></paragraph> 107*b1cdbd2cSJim Jagielski </section> 108*b1cdbd2cSJim Jagielski <section id="Section11"> 109*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_RELOADING" id="bm_id3157320" localize="false"/> 110*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3148451" role="heading" level="2" l10n="U" 111*b1cdbd2cSJim Jagielski oldref="38">Before reloading</paragraph> 112*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154218" role="paragraph" l10n="U" oldref="39"><ahelp hid="HID_EVT_RELOADING">The<emph> Before reloading </emph>event occurs before the form is reloaded.</ahelp> The data content has not yet been refreshed.</paragraph> 113*b1cdbd2cSJim Jagielski </section> 114*b1cdbd2cSJim Jagielski <section id="Section10"> 115*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_RELOADED" id="bm_id3154946" localize="false"/> 116*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3155102" role="heading" level="2" l10n="U" 117*b1cdbd2cSJim Jagielski oldref="40">When reloading</paragraph> 118*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3157895" role="paragraph" l10n="U" oldref="41"><ahelp hid="HID_EVT_RELOADED">The<emph> When reloading </emph>event occurs directly after the form has been reloaded.</ahelp> The data content has already been refreshed.</paragraph> 119*b1cdbd2cSJim Jagielski </section> 120*b1cdbd2cSJim Jagielski <section id="Section9"> 121*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_UNLOADING" id="bm_id3151116" localize="false"/> 122*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3152792" role="heading" level="2" l10n="U" 123*b1cdbd2cSJim Jagielski oldref="42">Before unloading</paragraph> 124*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3152598" role="paragraph" l10n="U" oldref="43"><ahelp hid="HID_EVT_UNLOADING">The<emph> Before unloading </emph>event occurs before the form is unloaded; that is, separated from its data source.</ahelp></paragraph> 125*b1cdbd2cSJim Jagielski </section> 126*b1cdbd2cSJim Jagielski <section id="Section8"> 127*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_UNLOADED" id="bm_id3152938" localize="false"/> 128*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3154145" role="heading" level="2" l10n="U" 129*b1cdbd2cSJim Jagielski oldref="44">When unloading</paragraph> 130*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154638" role="paragraph" l10n="U" oldref="45"><ahelp hid="HID_EVT_UNLOADED">The<emph> When unloading </emph>event occurs directly after the form has been unloaded; that is, separated from its data source.</ahelp></paragraph> 131*b1cdbd2cSJim Jagielski </section> 132*b1cdbd2cSJim Jagielski <section id="Section7"> 133*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_CONFIRMDELETE" id="bm_id3154127" localize="false"/> 134*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3147426" role="heading" level="2" l10n="U" 135*b1cdbd2cSJim Jagielski oldref="25">Confirm deletion</paragraph> 136*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154988" role="paragraph" l10n="U" oldref="26"><ahelp hid="HID_EVT_CONFIRMDELETE">The<emph> Confirm deletion </emph>event occurs as soon as data has been deleted from the form.</ahelp> For example, the linked macro can request confirmation in a dialog.</paragraph> 137*b1cdbd2cSJim Jagielski </section> 138*b1cdbd2cSJim Jagielski <section id="Section6"> 139*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_APPROVEROWCHANGE" id="bm_id3151351" localize="false"/> 140*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3149481" role="heading" level="2" l10n="U" 141*b1cdbd2cSJim Jagielski oldref="46">Before record action</paragraph> 142*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3156007" role="paragraph" l10n="U" oldref="58"><ahelp hid="HID_EVT_APPROVEROWCHANGE">The<emph> Before record action </emph>event occurs before the current record is changed.</ahelp> For example, the linked macro can request confirmation in a dialog.</paragraph> 143*b1cdbd2cSJim Jagielski </section> 144*b1cdbd2cSJim Jagielski <section id="Section5"> 145*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_ROWCHANGE" id="bm_id3150685" localize="false"/> 146*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3145749" role="heading" level="2" l10n="U" 147*b1cdbd2cSJim Jagielski oldref="47">After record action</paragraph> 148*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3146975" role="paragraph" l10n="U" oldref="59"><ahelp hid="HID_EVT_ROWCHANGE">The<emph> After record action </emph>event occurs directly after the current record has been changed.</ahelp></paragraph> 149*b1cdbd2cSJim Jagielski </section> 150*b1cdbd2cSJim Jagielski <section id="Section4"> 151*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_POSITIONING" id="bm_id3155413" localize="false"/> 152*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3154012" role="heading" level="2" l10n="U" 153*b1cdbd2cSJim Jagielski oldref="48">Before record change</paragraph> 154*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149664" role="paragraph" l10n="U" oldref="60"><ahelp hid="HID_EVT_POSITIONING">The<emph> Before record change </emph>event occurs before the current record pointer is changed.</ahelp>. For example, the linked macro can prevent this action by returning "FALSE".</paragraph> 155*b1cdbd2cSJim Jagielski </section> 156*b1cdbd2cSJim Jagielski <section id="Section3"> 157*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_POSITIONED" id="bm_id3150420" localize="false"/> 158*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3157975" role="heading" level="2" l10n="U" 159*b1cdbd2cSJim Jagielski oldref="49">After record change</paragraph> 160*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3154098" role="paragraph" l10n="U" oldref="61"><ahelp hid="HID_EVT_POSITIONED">The<emph> After record change </emph>event occurs directly after the current record pointer has been changed.</ahelp>.</paragraph> 161*b1cdbd2cSJim Jagielski </section> 162*b1cdbd2cSJim Jagielski <section id="Section2"> 163*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_APPROVEPARAMETER" id="bm_id3149298" localize="false"/> 164*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3151076" role="heading" level="2" l10n="U" 165*b1cdbd2cSJim Jagielski oldref="50">Fill parameters</paragraph> 166*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3147396" role="paragraph" l10n="U" oldref="62"><ahelp hid="HID_EVT_APPROVEPARAMETER">The<emph> Fill parameters </emph>event occurs when the form to be loaded has parameters that must be filled out.</ahelp> For example, the data source of the form can be the following SQL command:</paragraph> 167*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3148773" role="paragraph" l10n="U" oldref="63">SELECT * FROM address WHERE name=:name</paragraph> 168*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149581" role="paragraph" l10n="U" oldref="64">Here :name is a parameter that must be filled out when loading. The parameter is automatically filled out from the parent form if possible. If the parameter cannot be filled out, this event is called and a linked macro can fill out the parameter.</paragraph> 169*b1cdbd2cSJim Jagielski </section> 170*b1cdbd2cSJim Jagielski <section id="Section1"> 171*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_EVT_ERROROCCURED" id="bm_id3148387" localize="false"/> 172*b1cdbd2cSJim Jagielski<paragraph xml-lang="en-US" id="hd_id3146926" role="heading" level="2" l10n="U" oldref="9">Error occurred</paragraph> 173*b1cdbd2cSJim Jagielski <paragraph xml-lang="en-US" id="par_id3149485" role="paragraph" l10n="U" oldref="10"><ahelp hid="HID_EVT_ERROROCCURED">The<emph> Error occurred </emph>event is activated if an error occurs when accessing the data source.</ahelp> This applies to forms, list boxes and combo boxes.</paragraph> 174*b1cdbd2cSJim Jagielski </section> 175*b1cdbd2cSJim Jagielski</sort> 176*b1cdbd2cSJim Jagielski</body> 177*b1cdbd2cSJim Jagielski</helpdocument>