Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: document ::
unpublished | interface XStorageBasedDocument |
Usage Restrictions not published Description allows to initialize document with a storage, to store document to a storage, and to set document to be based on provided storage.

Methods' Summary
loadFromStorage | lets the document load itself using provided storage.
storeToStorage | lets the document store itself to the provided storage.
switchToStorage | allows to switch the document to the provided storage.
getDocumentStorage | allows to get the storage the document is based on.
addStorageChangeListener | allows to register a listener that will be notified when another storage is set to the document.
removeStorageChangeListener | allows to deregister the listener.

Methods' Details
loadFromStorage
void
loadFromStorage( | [in] ::com::sun::star::embed::XStorage | xStorage,
| [in] sequence< ::com::sun::star::beans::PropertyValue > | aMediaDescriptor )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::frame::DoubleInitializationException, ::com::sun::star::io::IOException, ::com::sun::star::uno::Exception );
Description lets the document load itself using provided storage.
storeToStorage
void
storeToStorage( | [in] ::com::sun::star::embed::XStorage | xStorage,
| [in] sequence< ::com::sun::star::beans::PropertyValue > | aMediaDescriptor )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::uno::Exception );
Description lets the document store itself to the provided storage.
switchToStorage
void
switchToStorage( | [in] ::com::sun::star::embed::XStorage | xStorage )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::uno::Exception );
Description allows to switch the document to the provided storage.
getDocumentStorage
::com::sun::star::embed::XStorage
getDocumentStorage()
raises( | ::com::sun::star::io::IOException, ::com::sun::star::uno::Exception );
Description allows to get the storage the document is based on.
addStorageChangeListener
void
addStorageChangeListener( | [in] XStorageChangeListener | xListener );
Description allows to register a listener that will be notified when another storage is set to the document.
removeStorageChangeListener
void
removeStorageChangeListener( | [in] XStorageChangeListener | xListener );
Description allows to deregister the listener.

Top of Page

Copyright © 2000, 2013 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.