helpcontent2/source/text/shared/02/01170202.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <helpdocument version="1.0">
   3
   4 <!--
   5 ***********************************************************************
   6  *
   7  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   8  *
   9  * Copyright 2008 by Sun Microsystems, Inc.
  10  *
  11  * OpenOffice.org - a multi-platform office productivity suite
  12  *
  13  * $RCSfile: soffice2xmlhelp.xsl,v $
  14  * $Revision: 1.12 $
  15  *
  16  * This file is part of OpenOffice.org.
  17  *
  18  * OpenOffice.org is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU Lesser General Public License version 3
  20  * only, as published by the Free Software Foundation.
  21  *
  22  * OpenOffice.org is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU Lesser General Public License version 3 for more details
  26  * (a copy is included in the LICENSE file that accompanied this code).
  27  *
  28  * You should have received a copy of the GNU Lesser General Public License
  29  * version 3 along with OpenOffice.org.  If not, see
  30  * <http://www.openoffice.org/license.html>
  31  * for a copy of the LGPLv3 License.
  32  *
  33  ************************************************************************
  34  -->
  35
  36
  37 <meta>
  38       <topic id="textshared0201170202xml" indexer="include" status="PUBLISH">
  39          <title xml-lang="en-US" id="tit">Events</title>
  40          <filename>/text/shared/02/01170202.xhp</filename>
  41       </topic>
  42    </meta>
  43    <body>
  44       <section id="ereignisse">
  45 <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"><bookmark_value>forms; events</bookmark_value>
  46          <bookmark_value>events;in forms</bookmark_value>
  47 </bookmark>
  48 <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>
  49          <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>
  50       </section>
  51       <section id="howtoget">
  52          <embed href="text/shared/00/00040501.xhp#formulareigenschaftenereignisse"/>
  53       </section>
  54       <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>
  55       <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>
  56       <list type="ordered">
  57          <listitem>
  58             <paragraph xml-lang="en-US" id="par_id3166460" role="listitem" l10n="U" oldref="30">Displaying an error message,</paragraph>
  59          </listitem>
  60       </list>
  61       <list type="ordered">
  62          <listitem>
  63             <paragraph xml-lang="en-US" id="par_id3152996" role="listitem" l10n="U" oldref="31">Confirming a delete process (for data records),</paragraph>
  64          </listitem>
  65       </list>
  66       <list type="ordered">
  67          <listitem>
  68             <paragraph xml-lang="en-US" id="par_id3153541" role="listitem" l10n="U" oldref="32">Querying parameters,</paragraph>
  69          </listitem>
  70       </list>
  71       <list type="ordered">
  72          <listitem>
  73             <paragraph xml-lang="en-US" id="par_id3155261" role="listitem" l10n="U" oldref="33">Checking input when saving a data record.</paragraph>
  74          </listitem>
  75       </list>
  76       <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>
  77       <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>
  78       <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>
  79 <sort order="asc">
  80 <section id="reset_update">
  81          <paragraph xml-lang="en-US" id="hd_id3147559" role="heading" level="2" l10n="U"
  82                     oldref="17">Before update</paragraph>
  83          <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>
  84 <bookmark xml-lang="en-US" branch="hid/HID_EVT_AFTERUPDATE" id="bm_id3154073" localize="false"/>
  85 <paragraph xml-lang="en-US" id="hd_id3153779" role="heading" level="2" l10n="U"
  86                     oldref="19">After update</paragraph>
  87          <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>
  88 <bookmark xml-lang="en-US" branch="hid/HID_EVT_APPROVERESETTED" id="bm_id3154851" localize="false"/>
  89 <paragraph xml-lang="en-US" id="hd_id3157909" role="heading" level="2" l10n="U"
  90                     oldref="36">Prior to reset</paragraph>
  91          <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>
  92          <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>
  93          <list type="ordered">
  94             <listitem>
  95                <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>
  96             </listitem>
  97             <listitem>
  98                <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>
  99             </listitem>
 100          </list>
 101 <bookmark xml-lang="en-US" branch="hid/HID_EVT_RESETTED" id="bm_id3152473" localize="false"/>
 102 <paragraph xml-lang="en-US" id="hd_id3156119" role="heading" level="2" l10n="U"
 103                     oldref="37">After resetting</paragraph>
 104          <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>
 105       </section>
 106       <section id="Section13">
 107 <bookmark xml-lang="en-US" branch="hid/HID_EVT_SUBMITTED" id="bm_id3147084" localize="false"/>
 108 <paragraph xml-lang="en-US" id="hd_id3150870" role="heading" level="2" l10n="U"
 109                     oldref="27">Before submitting</paragraph>
 110          <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>
 111       </section>
 112       <section id="Section12">
 113 <bookmark xml-lang="en-US" branch="hid/HID_EVT_LOADED" id="bm_id3151383" localize="false"/>
 114 <paragraph xml-lang="en-US" id="hd_id3149167" role="heading" level="2" l10n="U" oldref="5">When loading</paragraph>
 115          <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>
 116       </section>
 117       <section id="Section11">
 118 <bookmark xml-lang="en-US" branch="hid/HID_EVT_RELOADING" id="bm_id3157320" localize="false"/>
 119 <paragraph xml-lang="en-US" id="hd_id3148451" role="heading" level="2" l10n="U"
 120                     oldref="38">Before reloading</paragraph>
 121          <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>
 122       </section>
 123       <section id="Section10">
 124 <bookmark xml-lang="en-US" branch="hid/HID_EVT_RELOADED" id="bm_id3154946" localize="false"/>
 125 <paragraph xml-lang="en-US" id="hd_id3155102" role="heading" level="2" l10n="U"
 126                     oldref="40">When reloading</paragraph>
 127          <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>
 128       </section>
 129       <section id="Section9">
 130 <bookmark xml-lang="en-US" branch="hid/HID_EVT_UNLOADING" id="bm_id3151116" localize="false"/>
 131 <paragraph xml-lang="en-US" id="hd_id3152792" role="heading" level="2" l10n="U"
 132                     oldref="42">Before unloading</paragraph>
 133          <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>
 134       </section>
 135       <section id="Section8">
 136 <bookmark xml-lang="en-US" branch="hid/HID_EVT_UNLOADED" id="bm_id3152938" localize="false"/>
 137 <paragraph xml-lang="en-US" id="hd_id3154145" role="heading" level="2" l10n="U"
 138                     oldref="44">When unloading</paragraph>
 139          <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>
 140       </section>
 141       <section id="Section7">
 142 <bookmark xml-lang="en-US" branch="hid/HID_EVT_CONFIRMDELETE" id="bm_id3154127" localize="false"/>
 143 <paragraph xml-lang="en-US" id="hd_id3147426" role="heading" level="2" l10n="U"
 144                     oldref="25">Confirm deletion</paragraph>
 145          <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>
 146       </section>
 147       <section id="Section6">
 148 <bookmark xml-lang="en-US" branch="hid/HID_EVT_APPROVEROWCHANGE" id="bm_id3151351" localize="false"/>
 149 <paragraph xml-lang="en-US" id="hd_id3149481" role="heading" level="2" l10n="U"
 150                     oldref="46">Before record action</paragraph>
 151          <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>
 152       </section>
 153       <section id="Section5">
 154 <bookmark xml-lang="en-US" branch="hid/HID_EVT_ROWCHANGE" id="bm_id3150685" localize="false"/>
 155 <paragraph xml-lang="en-US" id="hd_id3145749" role="heading" level="2" l10n="U"
 156                     oldref="47">After record action</paragraph>
 157          <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>
 158       </section>
 159       <section id="Section4">
 160 <bookmark xml-lang="en-US" branch="hid/HID_EVT_POSITIONING" id="bm_id3155413" localize="false"/>
 161 <paragraph xml-lang="en-US" id="hd_id3154012" role="heading" level="2" l10n="U"
 162                     oldref="48">Before record change</paragraph>
 163          <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>
 164       </section>
 165       <section id="Section3">
 166 <bookmark xml-lang="en-US" branch="hid/HID_EVT_POSITIONED" id="bm_id3150420" localize="false"/>
 167 <paragraph xml-lang="en-US" id="hd_id3157975" role="heading" level="2" l10n="U"
 168                     oldref="49">After record change</paragraph>
 169          <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>
 170       </section>
 171       <section id="Section2">
 172 <bookmark xml-lang="en-US" branch="hid/HID_EVT_APPROVEPARAMETER" id="bm_id3149298" localize="false"/>
 173 <paragraph xml-lang="en-US" id="hd_id3151076" role="heading" level="2" l10n="U"
 174                     oldref="50">Fill parameters</paragraph>
 175          <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>
 176          <paragraph xml-lang="en-US" id="par_id3148773" role="paragraph" l10n="U" oldref="63">SELECT * FROM address WHERE name=:name</paragraph>
 177          <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>
 178       </section>
 179       <section id="Section1">
 180 <bookmark xml-lang="en-US" branch="hid/HID_EVT_ERROROCCURED" id="bm_id3148387" localize="false"/>
 181 <paragraph xml-lang="en-US" id="hd_id3146926" role="heading" level="2" l10n="U" oldref="9">Error occurred</paragraph>
 182          <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>
 183       </section>
 184 </sort>
 185 </body>
 186 </helpdocument>