Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XLibraryContainer
Base Interfaces
XLibraryContainer
┗ ::com::sun::star::container::XNameAccess
   ┗ ::com::sun::star::container::XElementAccess
::com::sun::star::container::XNameAccess
(referenced interface's summary:)
is used to access named objects within a container.
Description
Provides access to a library system.
Methods' Summary
createLibrary Creates a new library  
createLibraryLink Creates a link to an "external" library that then can be accessed using this library manager. The format of the StorageURL is a matter of the implementation. If the read only flag is set, the linked library cannot be modified. In this case, the returned interface really is only an XNameAccess. If ReadOnly is false (and the referenced storage allows write access) the returned interface also can be a ::com::sun::star::container::XNameContainer.  
removeLibrary removes the library item with the specified name. If the accessed library item is a link only the link is removed, not the target library.  
isLibraryLoaded returns true if the accessed library is already loaded from the storage, otherwise false.  
loadLibrary Causes the accessed library to be loaded from its storage if it hasn't already been loaded.  
Methods' Details
createLibrary
::com::sun::star::container::XNameContainer
createLibrary( [in] string  Name )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::ElementExistException );
Description
Creates a new library
createLibraryLink
::com::sun::star::container::XNameAccess
createLibraryLink( [in] string  Name,
[in] string  StorageURL,
[in] boolean  ReadOnly )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::ElementExistException );
Description
Creates a link to an "external" library that then can be accessed using this library manager. The format of the StorageURL is a matter of the implementation. If the read only flag is set, the linked library cannot be modified. In this case, the returned interface really is only an XNameAccess. If ReadOnly is false (and the referenced storage allows write access) the returned interface also can be a ::com::sun::star::container::XNameContainer.
removeLibrary
void
removeLibrary( [in] string  Name )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException );
Description
removes the library item with the specified name. If the accessed library item is a link only the link is removed, not the target library.
isLibraryLoaded
boolean
isLibraryLoaded( [in] string  Name )
raises( ::com::sun::star::container::NoSuchElementException );
Description
returns true if the accessed library is already loaded from the storage, otherwise false.
loadLibrary
void
loadLibrary( [in] string  Name )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException );
Description
Causes the accessed library to be loaded from its storage if it hasn't already been loaded.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

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.