interface XLibraryContainer in module com::sun::star::script::

(Global Index)

Syntax

interface XLibraryContainer : com::sun::star::container::XNameAccess ;

Description

Provides access to a library system.

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

Method Details



createLibrary

Syntax

com::sun::star::script::XNameContainer createLibrary (
string Name )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::container::ElementExistException );

Description

Creates a new library


createLibraryLink

Syntax

com::sun::star::script::XNameAccess createLibraryLink (
string Name,
string StorageURL,
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 XNameContainer.


removeLibrary

Syntax

void removeLibrary (
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

Syntax

boolean isLibraryLoaded (
string Name )
raises ( com::sun::star::container::NoSuchElementException );

Description

returns true if the accessed library is already loaded from the storage, otherwise false.


loadLibrary

Syntax

void loadLibrary (
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