Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished interface XVBAMacroResolver
Usage Restrictions
not published
Description
Converts VBA macro names to script URLs and vice versa.

Methods' Summary
resolveVBAMacroToScriptURL Returns the script URL representing the passed VBA macro name.  
resolveScriptURLtoVBAMacro Returns the VBA macro name for a macro with the passed script URL.  
Methods' Details
resolveVBAMacroToScriptURL
string
resolveVBAMacroToScriptURL( [in] string  aVBAMacroName )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns the script URL representing the passed VBA macro name.
Parameter aVBAMacroName
The VBA macro name to be resolved to a script URL. The macro name may consist of up to three parts, divided by periods. The first two parts are optional. The first part represents the VBA project name. The second part represents the module name. The third part represents the procedure name. Example: All the VBA macro names "VBAProject.Module1.TestMacro", "Module1.TestMacro", "VBAProject.TestMacro", and "TestMacro" may refer to the same VBA procedure located in "Module" of the project "VBAProject". If the module name is missing, then all modules are searched for a macro with the specified name.
Returns
The script URL referring to the passed VBA macro.
Throws
::com::sun::star::lang::IllegalArgumentException if a macro with the passed name does not exist.
resolveScriptURLtoVBAMacro
string
resolveScriptURLtoVBAMacro( [in] string  aScriptURL )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Returns the VBA macro name for a macro with the passed script URL.
Parameter aScriptURL
The script URL to be resolved to a VBA macro name. Must be a document-local script.
Returns
The VBA macro name referring to a macro with the passed script URL.
Throws
::com::sun::star::lang::IllegalArgumentException if a macro with the passed name does not exist.
Top of Page

Apache Software Foundation

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

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