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 ::

deprecated interface XLibraryAccess
Usage Restrictions
deprecated
Description
provides access to additional scripting code.

This code is organized in modules and these modules contain the functions. It is possible to get just the code from a function, but you can also get the whole code of a module with all functions in it.


Methods' Summary
isFunction returns true, if the function is accessible through this library; otherwise it returns false.  
isValidPath returns true if a fully qualified function name begins with this name.  
getModuleNames Return all module names which contain code. e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }  
getModuleSource get the source code of a module.  
getModuleCode Get the hole compiled code of a module.  
getFunctionSource get the source code of a function.  
getFunctionCode Get the compiled code of a function.  
Methods' Details
isFunction
boolean
isFunction( [in] string  aFunctionName );

Description
returns true, if the function is accessible through this library; otherwise it returns false.
Parameter aFunctionName
the fully qualified name of a funtion. (e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
isValidPath
boolean
isValidPath( [in] string  aPathName );

Description
returns true if a fully qualified function name begins with this name.
Parameter aPathName
a part of a function name (e.g., "UtilLibrary").
getModuleNames
sequence< string >
getModuleNames();

Description
Return all module names which contain code. e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
getModuleSource
string
getModuleSource( [in] string  aModulName );

Description
get the source code of a module.
getModuleCode
sequence< byte >
getModuleCode( [in] string  aModuleName );

Description
Get the hole compiled code of a module.
Parameter ModuleName
the full qualified name of a module. (e.g., "UtilLibrary.ModuleDate")
Returns
an empty sequence, if this module is not found or the code is not compiled.
getFunctionSource
string
getFunctionSource( [in] string  aFunctionName );

Description
get the source code of a function.
getFunctionCode
sequence< byte >
getFunctionCode( [in] string  FunctionName );

Description
Get the compiled code of a function.
Parameter FunctionName
the full qualified name of a function. (e.g., "UtilLibrary.ModuleDate.Function.CurrentDate")
Returns
an empty sequence, if this function is not found.
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.