Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XStorageBasedLibraryContainer
Base Interfaces
XStorageBasedLibraryContainerXPersistentLibraryContainer
   ┣ ::com::sun::star::util::XModifiable
   ┃ ┗ ::com::sun::star::util::XModifyBroadcasterXLibraryContainer2XLibraryContainer
         ┗ ::com::sun::star::container::XNameAccess
            ┗ ::com::sun::star::container::XElementAccess

XPersistentLibraryContainer
(referenced interface's summary:)
describes a container of script libraries which is persistent.
Usage Restrictions
not published
Description
is the interface for an XLibraryContainer which can be made persistent in an ::com::sun::star::embed::XStorage.

A persistent library container is associated with a root storage. The container is responsible for a particular sub storage of the root storage, the container storage.

Since
OOo 2.3

Methods' Summary
storeLibrariesToStorage stores the libraries to a storage other than the current container storage  
Attributes' Summary
RootStorage denotes the root storage associated with the container.  
Methods' Details
storeLibrariesToStorage
void
storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage  RootStorage )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException );

Description
stores the libraries to a storage other than the current container storage

Note that the library continer is not automatically associated with the new root storage. Instead, you need to manually set the ::RootStroage attribute afterwards. This separation allows for Save-To as well Save-As operations.

Parameter RootStorage
denotes the root storage into which the libraries should be written, which must not be NULL.
Note that the actual libraries are written into a sub storage of this root storage, as usual.
Throws
::com::sun::star::lang::IllegalArgumentException if the RootStorage parameter is NULL, or equals RootStorage.
Throws
::com::sun::star::lang::WrappedTargetException if an error occurs during storing.
Attributes' Details
RootStorage
::com::sun::star::embed::XStorage RootStorage
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
denotes the root storage associated with the container.

Effectively, this attribute is a typed version of XPersistentLibraryContainer::RootLocation, it's guaranteed that at every time, XPersistentLibraryContainer::RootLocation and RootStorage have the same value.

You should only set this attribute to a new value if you previously called storeLibrariesToStorage with the same storage. Setting this attribute to a storage into which the container has not been stored previously might result in unexpected behaviour.

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.