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

interface XVBAEventProcessor

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. `FALSE`, for all other cases.
processVbaEvent
boolean
processVbaEvent( [in] long  nEventId,
[in] sequence< any >  aArgs )
raises( ::com::sun::star::lang::IllegalArgumentException,
::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.
Returns
`TRUE`, if event handing is enabled, and the event handler macro exists and has been invoked.
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::util::VetoException if the VBA event handler has indicated to veto the event.
Top of Page