Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: script ::
interface XLibraryContainer
  Base Interfaces
      XLibraryContainer
      ┗ ::com::sun::star::container::XNameAccess
         ┗ ::com::sun::star::container::XElementAccess
  ::com::sun::star::container::XNameAccess | (referenced interface's summary:) is used to access named objects within a container.
Description Provides access to a library system.

Methods' 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 ::com::sun::star::container::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.

Methods' Details
createLibrary
::com::sun::star::container::XNameContainer
createLibrary( | [in] string | Name )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException );
Description Creates a new library
createLibraryLink
::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 );
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 ::com::sun::star::container::XNameContainer.
removeLibrary
void
removeLibrary( | [in] 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
boolean
isLibraryLoaded( | [in] string | Name )
raises( | ::com::sun::star::container::NoSuchElementException );
Description returns true if the accessed library is already loaded from the storage, otherwise false.
loadLibrary
void
loadLibrary( | [in] 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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.