Interface XLibraryContainer2

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

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

interface XLibraryContainer2

Base Interfaces

XLibraryContainer2
┗ XLibraryContainer
   ┗ ::com::sun::star::container::XNameAccess
      ┗ ::com::sun::star::container::XElementAccess

XLibraryContainer

(referenced interface's summary:): Provides access to a library system.

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

Methods' 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.

Methods' Details

isLibraryLink

boolean
isLibraryLink(	[in] 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

string
getLibraryLinkURL(	[in] 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

boolean
isLibraryReadOnly(	[in] 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

void
setLibraryReadOnly(	[in] string	Name,
	[in] 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

void
renameLibrary(	[in] string	Name,
	[in] 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

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.

API

SDK

Tips ‘n’ Tricks

Miscellaneous