Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished constants group VBAScriptEventId
Usage Restrictions
not published
Description
Identifies a VBA script event fired via broadcastVBAScriptEvent, and received by XVBAScriptListener::notifyVBAScriptEvent.
See also
VBAScriptEvent, XVBACompatibility, XVBAScriptListener

Constants
SCRIPT_STARTED This event is fired when a VBA script in the current document has been started.  
SCRIPT_STOPPED This event is fired when a VBA script in the current document stops running.  
INITIALIZE_USERFORM This event is fired when a VBA script in the current document tries to instanciate a userform.  
Constants' Details
SCRIPT_STARTED
const long SCRIPT_STARTED = 0;
Description
This event is fired when a VBA script in the current document has been started.

Several scripts may run simultaneously, e.g. when a running script triggers a document event that starts another script.

The number of running scripts can be obtained via XVBACompatibility::RunningVBAScripts. The number returned there will already contain the new script notified with this event.

The member VBAScriptEvent::ModuleName of the event object will contain the name of the code module that contains the started script.

SCRIPT_STOPPED
const long SCRIPT_STOPPED = 1;
Description
This event is fired when a VBA script in the current document stops running.

Several scripts may run simultaneously, e.g. when a running script triggers a document event that starts another script.

The number of scripts still running can be obtained via XVBACompatibility::RunningVBAScripts. The number returned there will not contain the stopped script notified with this event anymore.

The member VBAScriptEvent::ModuleName of the event object will contain the name of the code module that contains the script that has been stopped.

INITIALIZE_USERFORM
const long INITIALIZE_USERFORM = 2;
Description
This event is fired when a VBA script in the current document tries to instanciate a userform.

The member VBAScriptEvent::ModuleName of the event object will contain the name of the userform module.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.