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 XStarBasicAccess
Usage Restrictions
deprecated
Description
Interface representing a library and provides access to its modules

Methods' Summary
getLibraryContainer returns the library container giving access to the libraries stored in a document or basic library file.  
createLibrary Creates an empty library. This method can be called alternatively to accessing directly the NameContainer returned by getLibraryContainer. By using this method together with addModule and addStarBasicDialog the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo, and XStarBasicDialogInfo  
addModule Adds a module to an existing (e.g., created by createLibrary) library. By using this method together with createLibrary the caller does not have to implement XStarBasicLibraryInfo and XModuleInfo.  
addDialog Adds an old style basic dialog (SI controls) to an existing (e.g., created by createLibrary) library. By using this method together with createLibrary the caller does not have to implement XStarBasicLibraryInfo and XStarBasicDialogInfo  
Methods' Details
getLibraryContainer
::com::sun::star::container::XNameContainer
getLibraryContainer();

Description
returns the library container giving access to the libraries stored in a document or basic library file.
createLibrary
void
createLibrary( [in] string  LibName,
[in] string  Password,
[in] string  ExternalSourceURL,
[in] string  LinkTargetURL )
raises( ::com::sun::star::container::ElementExistException );

Description
Creates an empty library. This method can be called alternatively to accessing directly the NameContainer returned by getLibraryContainer. By using this method together with addModule and addStarBasicDialog the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo, and XStarBasicDialogInfo
addModule
void
addModule( [in] string  LibraryName,
[in] string  ModuleName,
[in] string  Language,
[in] string  Source )
raises( ::com::sun::star::container::NoSuchElementException );

Description
Adds a module to an existing (e.g., created by createLibrary) library. By using this method together with createLibrary the caller does not have to implement XStarBasicLibraryInfo and XModuleInfo.
Throws
NoSuchElementException if the library doesn't exist.
addDialog
void
addDialog( [in] string  LibraryName,
[in] string  DialogName,
[in] sequence< byte >  Data )
raises( ::com::sun::star::container::NoSuchElementException );

Description
Adds an old style basic dialog (SI controls) to an existing (e.g., created by createLibrary) library. By using this method together with createLibrary the caller does not have to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
Throws
NoSuchElementException if the library doesn't 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.