Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

interface XStorageBasedDocument
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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.