:: com :: sun :: star :: script :: vba ::

unpublished interface XVBAEventProcessor
Usage Restrictions
not published
Description
Executes VBA event handlers.

Methods' Summary
hasVbaEventHandler Returns whether a VBA event handler exists.  
processVbaEvent Executes a VBA event handler.  
Methods' Details
hasVbaEventHandler
boolean
hasVbaEventHandler( [in] long  nEventId,
[in] sequence< any >  aArgs )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns whether a VBA event handler exists.
Parameter nEventId
The identifier of the event. Must be a constant from VBAEventId.
Parameter aArgs
Additional arguments needed to identify some event handlers, e.g. a sheet index for spreadsheet events.
Returns
true, if the VBA event handler exists.
Throws
::com::sun::star::lang::IllegalArgumentException if the passed event identifier is not supported, or if the passed specifier is required but invalid.
processVbaEvent
void
processVbaEvent( [in] long  nEventId,
[in] sequence< any >  aArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::script::provider::ScriptFrameworkErrorException,
::com::sun::star::util::VetoException );

Description
Executes a VBA event handler.
Parameter nEventId
The identifier of the event. Must be a constant from VBAEventId.
Parameter aArgs
The input arguments needed to create the argument list of the VBA event handler.
Throws
::com::sun::star::lang::IllegalArgumentException if the passed event identifier is not supported, or if the passed arguments do not conform to the arguments expected by the specified event.
Throws
::com::sun::star::script::provider::ScriptFrameworkErrorException if the VBA event handler could not be invoked. Reasons may be, that handling of VBA events is not enabled, that the VBA event handler macro has not been found, or that the execution of the macro has been aborted with an error.
Throws
::com::sun::star::util::VetoException if the VBA event handler has indicated to veto the event.
Top of Page