<html> <head> <title>Interface XVBAEventProcessor</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XVBAEventProcessor-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">script</a> :: <a href="module-ix.html" class="namechain">vba</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XVBAEventProcessor</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>Executes VBA event handlers. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#hasVbaEventHandler">hasVbaEventHandler</a></td> <td class="imsum_right">Returns whether a VBA event handler exists. </td> </tr> <tr> <td class="imsum_left"><a href="#processVbaEvent">processVbaEvent</a></td> <td class="imsum_right">Executes a VBA event handler. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="hasVbaEventHandler" class="membertitle">hasVbaEventHandler</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasVbaEventHandler</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nEventId,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> aArgs )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns whether a VBA event handler exists. </dd> <dt><b>Parameter nEventId</b></dt> <dd>The identifier of the event. Must be a constant from <a href="VBAEventId.html">VBAEventId</a>. </dd> <dt><b>Parameter aArgs</b></dt> <dd>Additional arguments needed to identify some event handlers, e.g. a sheet index for spreadsheet events. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if the VBA event handler exists. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> if the passed event identifier is not supported, or if the passed specifier is required but invalid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="processVbaEvent" class="membertitle">processVbaEvent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>processVbaEvent</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nEventId,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> aArgs )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/VetoException.html">VetoException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Executes a VBA event handler. </dd> <dt><b>Parameter nEventId</b></dt> <dd>The identifier of the event. Must be a constant from <a href="VBAEventId.html">VBAEventId</a>. </dd> <dt><b>Parameter aArgs</b></dt> <dd>The input arguments needed to create the argument list of the VBA event handler. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if event handing is enabled, and the event handler macro exists and has been invoked. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> if the passed event identifier is not supported, or if the passed arguments do not conform to the arguments expected by the specified event. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/VetoException.html">VetoException</a> if the VBA event handler has indicated to veto the event. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
