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

(Global Index)

Syntax

interface XLibraryContainer2 : com::sun::star::script::XLibraryContainer ;

Description

Extension of XLibraryContainer to provide additional information about the libraries contained in a library container

Method Summary

isLibraryLink returns true if the accessed library item is a link, e.g., created by createLibraryLink, otherwise false.

getLibraryLinkURL returns the location of the library link target. Should return the same URL that was passed to createLibraryLink in the StorageURL parameter. If the accessed library item exists but isn't a link, a IllegalArgumentException is thrown

isLibraryReadOnly returns true if the accessed library item (library or library link) is read only. A library can be read only because it was set to read only using the methods provided by this interface or because of other reasons depending on the implementation (e.g., file system write protection)

setLibraryReadOnly Sets the accessed library item (library or library link) to read only according to the flag bReadOnly (true means read only)

renameLibrary renames the library item with the specified name. If the accessed library item is a link only the link is renamed, not the target library. If a library with the new name exists already a com::sun::star::container::ElementExistException is thrown.

Method Details



isLibraryLink

Syntax

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

Description

returns true if the accessed library item is a link, e.g., created by createLibraryLink, otherwise false.


getLibraryLinkURL

Syntax

string getLibraryLinkURL (
string Name )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::container::NoSuchElementException );

Description

returns the location of the library link target. Should return the same URL that was passed to createLibraryLink in the StorageURL parameter. If the accessed library item exists but isn't a link, a IllegalArgumentException is thrown


isLibraryReadOnly

Syntax

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

Description

returns true if the accessed library item (library or library link) is read only. A library can be read only because it was set to read only using the methods provided by this interface or because of other reasons depending on the implementation (e.g., file system write protection)


setLibraryReadOnly

Syntax

void setLibraryReadOnly (
string Name,
boolean bReadOnly )
raises ( com::sun::star::container::NoSuchElementException );

Description

Sets the accessed library item (library or library link) to read only according to the flag bReadOnly (true means read only)


renameLibrary

Syntax

void renameLibrary (
string Name,
string NewName )
raises ( com::sun::star::container::NoSuchElementException , com::sun::star::container::ElementExistException );

Description

renames the library item with the specified name. If the accessed library item is a link only the link is renamed, not the target library. If a library with the new name exists already a com::sun::star::container::ElementExistException is thrown.

Top of Page