XStorageBasedLibraryContainer Interface Reference

is the interface for an XLibraryContainer which can be made persistent in a com::sun::star::embed::XStorage. More...

import"XStorageBasedLibraryContainer.idl";

Inheritance diagram for XStorageBasedLibraryContainer:

Exported Interfaces
interface	XPersistentLibraryContainer
Exported Interfaces inherited from XPersistentLibraryContainer
interface	::com::sun::star::util::XModifiable
interface	XLibraryContainer2

Public Member Functions
void	storeLibrariesToStorage ([in] ::com::sun::star::embed::XStorage RootStorage) raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException )
	stores the libraries to a storage other than the current container storage More...
Public Member Functions inherited from XPersistentLibraryContainer
void	storeLibraries () raises ( ::com::sun::star::lang::WrappedTargetException )
	stores the libraries to the current location. More...
Public Member Functions inherited from XModifiable
boolean	isModified ()
void	setModified ([in] boolean bModified) raises ( com::sun::star::beans::PropertyVetoException )
	sets the status of the modified-flag from outside of the object. More...
Public Member Functions inherited from XModifyBroadcaster
void	addModifyListener ([in] com::sun::star::util::XModifyListener aListener)
	adds the specified listener to receive events "modified." More...
void	removeModifyListener ([in] com::sun::star::util::XModifyListener aListener)
	removes the specified listener. More...
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...
Public Member Functions inherited from XLibraryContainer2
boolean	isLibraryLink ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
	returns true if the accessed library item is a link, e.g., created by createLibraryLink, otherwise false. More...
string	getLibraryLinkURL ([in] string Name) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException )
	returns the location of the library link target. More...
boolean	isLibraryReadOnly ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
	returns true if the accessed library item (library or library link) is read only. More...
void	setLibraryReadOnly ([in] string Name, [in] boolean bReadOnly) raises ( com::sun::star::container::NoSuchElementException )
	Sets the accessed library item (library or library link) to read only according to the flag bReadOnly (true means read only) More...
void	renameLibrary ([in] string Name, [in] string NewName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException )
	renames the library item with the specified name. More...
Public Member Functions inherited from XLibraryContainer
com::sun::star::container::XNameContainer	createLibrary ([in] string Name) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException )
	Creates a new library. More...
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 )
	Creates a link to an "external" library that then can be accessed using this library manager. More...
void	removeLibrary ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
	removes the library item with the specified name. More...
boolean	isLibraryLoaded ([in] string Name) raises ( com::sun::star::container::NoSuchElementException )
	returns true if the accessed library is already loaded from the storage, otherwise false. More...
void	loadLibrary ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
	Causes the accessed library to be loaded from its storage if it hasn't already been loaded. More...
Public Member Functions inherited from XNameAccess
any	getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
sequence< string >	getElementNames ()
boolean	hasByName ([in] string aName)
Public Member Functions inherited from XElementAccess
type	getElementType ()
boolean	hasElements ()

Public Attributes
::com::sun::star::embed::XStorage	RootStorage { set raises(::com::sun::star::lang::IllegalArgumentException); }
	denotes the root storage associated with the container. More...
Public Attributes inherited from XPersistentLibraryContainer
any	RootLocation
	denotes the root location associated with the container. More...
string	ContainerLocationName
	denotes the name of the sub location where the container elements are actually stored. More...

Detailed Description

is the interface for an XLibraryContainer which can be made persistent in a 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

Exported Interfaces

XPersistentLibraryContainer

interface XPersistentLibraryContainer

Member Function Documentation

storeLibrariesToStorage()

void storeLibrariesToStorage	(	[in] ::com::sun::star::embed::XStorage	RootStorage	)
raises	(	::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::lang::WrappedTargetException
	)

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

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

Parameters

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.

Exceptions

com::sun::star::lang::IllegalArgumentException	if the RootStorage parameter is NULL, or equals RootStorage.
com::sun::star::lang::WrappedTargetException	if an error occurs during storing.

Member Data Documentation

RootStorage

::com::sun::star::embed::XStorage RootStorage set raises ( ::com::sun::star::lang::IllegalArgumentException )

attribute

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 behavior.

---

The documentation for this interface was generated from the following file:

• com/sun/star/script/XStorageBasedLibraryContainer.idl